Update README.md

This commit is contained in:
Jaidyn Ann 2024-01-12 11:13:07 -06:00
parent 83d9074e06
commit e8a34fa861

View File

@ -1,61 +1,68 @@
![i4 logo](res/i4_logo_scaled.png)
# ![i4](res/i4_logo_scaled.png)
#### **`i4`** is an inventory mod for Minetest.
![A screenshot of Minetest displaying i3s inventory.](res/screenshot.png)
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.
[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+**
This mod requires Minetest 5.6+, as it uses newer additions to the formspec API.
#### 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`.*
## 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`)
#### 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
### 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 inventory's font size is too big on certain setups (namely Windows 10/11 or 144 DPI display), you should lower the
### 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.
#### 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
## 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.