**Title:** Sway

**Description:** 

**Details:**
# Sway

Sway is a simple inventory mod for Minetest that makes use of [Flow] forms.

[![busted](https://github.com/Lazerbeak12345/sway-inv/actions/workflows/busted.yml/badge.svg)](https://github.com/Lazerbeak12345/sway-inv/actions/workflows/busted.yml)
[![luacheck](https://github.com/Lazerbeak12345/sway-inv/actions/workflows/luacheck.yml/badge.svg)](https://github.com/Lazerbeak12345/sway-inv/actions/workflows/luacheck.yml)
[![Coverage Status](https://img.shields.io/coverallsCoverage/github/Lazerbeak12345/sway-inv)](https://coveralls.io/github/Lazerbeak12345/sway-inv?branch=master)
[![versioned: semantically](https://img.shields.io/badge/versioned-semantically-orange)](https://semver.org)
![image badge containing latest version number](https://img.shields.io/github/v/tag/Lazerbeak12345/sway-inv?filter=*.*.*&label=latest%20version)

```text
 ____                                      ______
/\  _`\                                   /\__  _
\ \,\L\_\  __  __  __     __     __  __   \/_/\ \/     ___   __  __
 \/_\__ \ /\ \/\ \/\ \  /'__`\  /\ \/\ \     \ \ \   /' _ `\/\ \/\ 
   /\ \L\ \ \ \_/ \_/ \/\ \L\.\_\ \ \_\ \     \_\ \__/\ \/\ \ \ \_/ |__
   \ `\____\ \___x___/'\ \__/.\_\\/`____ \    /\_____\ \_\ \_\ \___//\_
    \/_____/\/__//__/   \/__/\/_/ `/___/> \   \/_____/\/_/\/_/\/__/ \/_/
                                     /\___/
                                     \/__/
```

Much like [SFINV], this mod is a "A cleaner, simpler solution to having an advanced inventory in Minetest." It's intended to be an excellent modding base.

Sway uses [Flow] formspecs for rendering. With Sway, formspec size is no longer a limit to your UI or UX. You can have fully dynamic layouts too!

Target audience is server owners and mod developers. Sway Inv is intended as the core component of a larger, more complete inventory mod. On my Github I have multiple such addons to make sway actually usable, but they are pre-beta phase and are _by far_ not ready for actual use yet.

## Features

- So simple that it doesn't depend on any games in particular.
- Rich API.
- Flow forms instead of ridgid and difficult to harden formspec strings

## FAQ

See [the FAQ section](https://github.com/Lazerbeak12345/sway-inv#faq) of the README on GitHub.

## Acknowledgements

 - [SFINV] Sway is a fork of SFINV by rubenwardy.
 - [Flow] Sway uses flow to render formspecs.
 - [readme.so] Readme (and this trimmed version of the readme) generated in part by readme.so.
 - [i3] Source of inspiration and some (very small amounts) of properly attributed, licence compatible code.
 - [Larry Gelberg][larry] The Sway Inv ascii art was generated via `echo "Sway Inv." | figlet -f larry3d`.
`larry3d` font is from the official figlet "contributed" collection. `pepper`
from the same collection was a close 2nd.

## License

Code: [MIT](https://choosealicense.com/licenses/mit/) (a copy is bundled at `./CODE_LICENSE.txt`)

* `sway_crafting_arrow.png` - renamed from a texture by paramat, derived from a texture by BlockMen (CC BY-SA 3.0).
* `sway_hb_bg.png` - renamed from `gui_hb_bg.png`, a texture by BlockMen (CC BY-SA 3.0)
* `sway_bg_full.png` - renamed from `i3_bg_full.png`, a texture by paramat (CC BY-SA 3.0)

For a copy of CC BY-SA 3.0 see `./MEDIA_LICENSE.txt` (bundled).

[SFINV]: https://content.luanti.org/packages/rubenwardy/sfinv/
[Flow]: https://content.luanti.org/packages/luk3yx/flow/
[readme.so]: https://readme.so
[i3]: https://content.luanti.org/packages/jp/i3/
[larry]: http://www.figlet.org/fontdb_example.cgi?font=larry3d.flf


**Tags:** developer_tools, gui, inventory, library
**Repository:** https://github.com/Lazerbeak12345/sway-inv
**License:** MIT