i3/README.md

54 lines
2.4 KiB
Markdown
Raw Normal View History

2020-12-30 23:22:38 +01:00
# i3
2020-12-30 23:21:05 +01:00
2021-11-21 05:47:31 +01:00
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs) ![workflow](https://github.com/minetest-mods/i3/actions/workflows/luacheck.yml/badge.svg) [![GitHub Release](https://img.shields.io/github/release/minetest-mods/i3.svg?style=flat)]() [![ContentDB](https://content.minetest.net/packages/jp/i3/shields/downloads/)](https://content.minetest.net/packages/jp/i3/) [![PayPal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.me/jpg84240)
2020-12-31 03:02:35 +01:00
2021-02-24 19:36:54 +01:00
#### **`i3`** is a next-generation inventory for Minetest.
2020-12-31 02:50:22 +01:00
2021-10-19 05:15:49 +02:00
This mod features a modern, powerful inventory menu with a good user experience.
2021-01-16 20:20:47 +01:00
**`i3`** provides a rich [**API**](https://github.com/minetest-mods/i3/blob/master/API.md) for mod developers who want to extend it.
2020-12-31 02:50:22 +01:00
2021-01-17 19:11:11 +01:00
This mod requires **Minetest 5.4+**
2020-12-31 02:50:22 +01:00
2021-01-16 20:20:47 +01:00
#### List of features:
- Crafting Guide (survival mode only)
2021-01-16 20:20:47 +01:00
- Progressive Mode¹
- Quick Crafting
- 3D Player Model Real-Time Preview
- Inventory Sorting (+ options: compression, reverse mode, automation, etc.)
- Item List Compression (**`moreblocks`** is supported)
2021-01-16 20:20:47 +01:00
- Item Bookmarks
2021-04-06 03:34:54 +02:00
- Waypoints
- Bags
- Home
2020-12-31 02:50:22 +01:00
2021-01-16 20:20:47 +01:00
**¹** *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/)
2021-01-23 03:35:45 +01:00
#### Recommendations
2021-08-10 01:57:36 +02:00
To use this mod in the best conditions:
2021-01-23 03:35:45 +01:00
2021-01-16 20:20:47 +01:00
- Use LuaJIT
2021-01-24 16:08:46 +01:00
- Use a HiDPI widescreen display
2021-01-25 19:28:28 +01:00
- Use the default Freetype font style
2021-01-16 20:20:47 +01:00
2021-10-19 05:15:49 +02:00
#### 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.
2021-01-25 20:44:04 +01:00
#### Notes
2021-02-08 01:32:33 +01:00
`i3` uses a larger inventory than the usual inventories in Minetest games.
2021-01-25 20:44:04 +01:00
Thus, most chests will be unadapted to this inventory size.
The `i3` inventory is 9 slots wide by default, such as Minecraft.
2021-01-16 20:20:47 +01:00
Report bugs on the [**Bug Tracker**](https://github.com/minetest-mods/i3/issues).
2021-01-16 20:20:47 +01:00
2021-11-21 22:47:46 +01:00
![Preview](https://user-images.githubusercontent.com/7883281/142780121-564c1969-b95b-4cc9-99df-9f2362c67e07.png)