i3/README.md
Jean-Patrick Guerrero 4c256095a8 Update README
2021-01-25 20:44:04 +01:00

51 lines
1.9 KiB
Markdown

# i3
[![ContentDB](https://content.minetest.net/packages/jp/i3/shields/title/)](https://content.minetest.net/packages/jp/i3/) [![ContentDB](https://content.minetest.net/packages/jp/i3/shields/downloads/)](https://content.minetest.net/packages/jp/i3/)
#### **`i3`** is the inventory of your wildest dreams.
This inventory offers a slick, modern UI made with the latest technologies of the Minetest engine.
**`i3`** provides a rich [**API**](https://github.com/minetest-mods/i3/blob/master/API.md) for mod developers who want to extend it.
This mod requires **Minetest 5.4+**
#### List of features:
- Crafting Guide (only in survival mode)
- Progressive Mode¹
- Quick Crafting
- Backpacks
- 3D Player Model Preview
- Inventory Sorting (alphabetical + item stack compression)
- Item Bookmarks
**¹** *This mode is a Terraria-like system that shows recipes you can craft from items you ever had in your inventory.
To enable it: `i3_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, it's recommended to follow these recommendations:
- Use LuaJIT
- Use a HiDPI widescreen display
- Use the default Freetype font style
#### Notes
`i3` uses a larger inventory (9 slots wide) than the usual inventories in Minetest.
Thus, most chests will be unadapted to this inventory size.
Report any bug on the [**Bug Tracker**](https://github.com/minetest-mods/i3/issues).
Love this mod? Donations are appreciated: https://www.paypal.me/jpg84240
Demo video: https://www.youtube.com/watch?v=mwpzKq0zVjg
![Preview](https://user-images.githubusercontent.com/7883281/104822375-38dc9c80-5842-11eb-902a-66a0dc50bf28.png)