minetest-i4/README.md
Jaidyn Ann 2b3df66a7d Rename fork to i4
Now that the API is actually changing, it seems
like a good point to rename the fork.
2024-01-12 03:18:59 -06:00

62 lines
2.2 KiB
Markdown

![i4 logo](res/i4_logo_scaled.png)
#### **`i4`** is an inventory mod for Minetest.
This mod features a modern, powerful inventory menu with a good user experience.
**`i4`** provides a rich [**API**](API.md) for mod developers who want to extend it.
This mod requires **Minetest 5.6+**
#### List of features:
- Crafting Guide (survival mode only)
- Progressive Mode¹
- Quick Crafting
- 3D Player Model Real-Time Preview
- Isometric Map Preview
- Inventory Sorting (+ options: compression, reverse mode, automation, etc.)
- Item List Compression (**`moreblocks`** is supported)
- Item Bookmarks
- Waypoints
- Bags
- Home
**¹** *This mode is a Terraria-like system that shows recipes you can craft from items you ever had in your inventory.
To enable it: `i4_progressive_mode = true` in `minetest.conf`.*
#### This mod officially supports the following mods:
- [**`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/)
#### Recommendations
To use this mod in the best conditions:
- Use LuaJIT
- Use the default Freetype font style
#### Troubleshooting
If the inventory's 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.
#### 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.
Report bugs on the [**Bug Tracker**](https:///notabug.org/jadedctrl/i4).
![Preview](res/screenshot.png)
#### License
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.