minetest-i4/README.md
2024-01-12 11:16:12 -06:00

69 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ![i4](res/i4_logo_scaled.png)
![A screenshot of Minetest displaying i3s inventory.](res/screenshot.png)
[i4](https://notabug.org/jadedctrl/i4) is an inventory system for Minetest with a focus on cohesion. It is a fork of [i3](https://github.com/minetest-mods/i3), the “next-generation inventory.” Primary differences to `i3` include an extended [API](API.md), more efficient use of screen-space, and general house-keeping.
This mod requires Minetest 5.6+, as it uses newer additions to the formspec API.
## Features
* Crafting guide
* Progressive mode
* Quick-crafting
* 3D player model real-time preview
* Isometric map preview
* Fine-tunable inventory sorting
* Item list compression (with `moreblocks` support)
* Item bookmarks
* Waypoints
* Bags
* Home (built-in or minetest_games `sethome`)
### Officially-supported mods
These mods have menus built-into i4:
* [**`3d_armor`**](https://content.minetest.net/packages/stu/3d_armor/)
* [**`skinsdb`**](https://content.minetest.net/packages/bell07/skinsdb/)
* [**`awards`**](https://content.minetest.net/packages/rubenwardy/awards/)
## Configuration
There is currently only one [`minetest.conf`](https://wiki.minetest.net/Minetest.conf) setting used by i4:
* `i4_progressive_mode = false` — A discovery-based system, where the crafting guide only displays recipes whose components you have held before.
## Notes
i4 uses a larger inventory than the usual inventories in Minetest games.
Thus, most chests will be unadapted to this inventory size.
The i4 inventory is 9 slots wide by default, such as Minecraft.
Please report bugs on the [bug tracker](https:///notabug.org/jadedctrl/i4) — I dont bite!
### Recommendations
To use this mod in the best conditions:
- Use LuaJIT
- Use the default Freetype font style
### Troubleshooting
If the inventorys font size is too big on certain setups (namely Windows 10/11 or 144 DPI display), you should lower the
value of the setting `display_density_factor` in your `minetest.conf`. Note that the change is applied after restart.
You can also use the font size slider in the inventory, settings window.
## Source-code
https://notabug.org/jadedctrl/i4
Sounds are under the CC0, by Lone_Wolf & MadPanCake.
Textures are under the CC BY-SA 3.0, by paramat & BlockMen.
Source code from 2024 onward is under the GNU GPLv3, contributions by Jaidyn Ann (jadedctrl).
Source code pre-2024 is under the MIT license, by Jean-Patrick Guerrero; contributions by SmallJoker & anonymous.
See [./LICENSE](LICENSE) for details.