mirror of
https://github.com/GTNewHorizons/NotEnoughItems.git
synced 2026-11-15 17:54:50 +00:00
94 lines
5.3 KiB
Markdown
94 lines
5.3 KiB
Markdown
# NotEnoughItems Unofficial - By the GTNH Team
|
|
|
|
🌐 **Languages:** [English](README.md) | [Українська](README_uk.md)
|
|
|
|
A continuation of NotEnoughItems for 1.7.10 by the developers of Gregtech: New Horizons modpack, with features either inspired and/or backported from JustEnoughItems
|
|
|
|
We've tested this against all of the mods included in GTNH, as well as a limited set of other mods (like Reika's mods). Every effort has been made to maintain backwards compatibility, however the focus is on the mods contained in the GTNH modpack.
|
|
|
|
If you have issues with NEI outside of the GTNH modpack you may report them in the [GTNH NEI GitHub](https://github.com/GTNewHorizons/NotEnoughItems).
|
|
|
|
## New Features:
|
|
|
|
* Speed
|
|
- Uses a parallel stream to search the item list over multiple cores, resulting in 2-6x faster searches on average
|
|
- Loads the recipe handlers in parallel
|
|
* A textbox for search with most of the features you'd expect - moving forward, backwards, selection, etc
|
|
* Bookmarks! Are you in the process of crafting? Bookmark it using either 'A' or configure your own key.
|
|
* Toggle bookmark pane. Default shortcut key `B`. Item Subsets menu is only available if bookmarks are not visible.
|
|
* Utility/Cheat buttons line up and wrap based on GUI size
|
|
* ItemList is no longer regenerated from the ItemRegistry on every inventory load
|
|
* JEI (Or Creative) Style tabs [Optional] Note: Requires explicit support to be added for an ItemStack to render, otherwise falls back to the first two letters of the handler name.
|
|
* Tabs/Handlers are loaded from a CSV config in the JAR (or optionally from the config folder). NBT IMCEvents `registerHandlerInfo` and `removeHandlerInfo` are available for mod authors to add handler information, using the same fields as the CSV file
|
|
* `@[Mod]->[item]` searching. ex: `@Mod.gregtech->iron ingot`
|
|
* Cycle between Recipe, Utility, and Cheat mode by ctrl clicking on the Wrench Icon
|
|
* GT5u Tools/Items and GT6 tools should now properly work with the Overlay Recipe Transfer
|
|
|
|
### Information Page Handler
|
|
Want to add some information about a block or item without making a massive tooltip for it? You can add information about any block or item by registering it in the Information Handler.
|
|
|
|
Information page(s) are displayed when either the uses or recipes of a matching item are searched. All matching items will cycle at the top of the information page.
|
|
|
|
Your mod can call:
|
|
```java
|
|
FMLInterModComms.sendMessage("NotEnoughItems", "addItemInfo", nbt);
|
|
```
|
|
Where nbt is an NBTTagCompound formatted as described below.
|
|
|
|
| Tag | Type | Description |
|
|
|------------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `filter` | String | A string filter to match what items should return this information page.<br/>modname:itemname, metadata, Ore Dictionary tags, and regex can all be used. The full format may be seen in `config/NEI/collapsibleitems.cfg`. |
|
|
| `page` / `pages` | String / String NBTTagList | The actual text to display. See below for differences between single and multi-page messages.<br/>Both formats will automatically translate provided strings. |
|
|
|
|
#### Single Page Format
|
|
|
|
Use the `"page"` string tag when you only want to add one page of information:
|
|
```java
|
|
NBTTagCompound tag = new NBTTagCompound();
|
|
tag.setString("filter", "minecraft:log 3");
|
|
tag.setString("page", "Exotic wood found in tropical climates.");
|
|
|
|
FMLInterModComms.sendMessage("NotEnoughItems", "addItemInfo", tag);
|
|
```
|
|
|
|
#### Multiple Page Format
|
|
|
|
Use the `"pages"` tag as an `NBTTagList` of strings when you want more than one page:
|
|
```java
|
|
NBTTagCompound tag = new NBTTagCompound();
|
|
tag.setString("filter", "minecraft:diamond_sword");
|
|
|
|
NBTTagList pages = new NBTTagList();
|
|
pages.appendTag(new NBTTagString("A powerful melee weapon."));
|
|
pages.appendTag(new NBTTagString("Can be enchanted for extra effects."));
|
|
|
|
tag.setTag("pages", pages);
|
|
|
|
FMLInterModComms.sendMessage("NotEnoughItems", "addItemInfo", tag);
|
|
```
|
|
* Each list entry is one page.
|
|
* Pages will appear in NEI with buttons to scroll through them.
|
|
|
|
#### Item Matching
|
|
|
|
All items that match `filter` will show your information page. See `config/NEI/collapsibleitems.cfg` for the full filter format.
|
|
|
|
#### Item Information Config File
|
|
|
|
If you're a modpack creator and want to make custom item information pages, they can easily be added in `config/NEI/informationpages.cfg`, which has a few more examples.
|
|
|
|
## Other items of note:
|
|
|
|
* Remove TMI style
|
|
* Removed inventory Load/Save state
|
|
|
|
## License
|
|
|
|
GTNH Modifications Copyright (c) 2019-2024 mitchej123 and the GTNH Team
|
|
|
|
Licensed under LGPL-3.0 or later - use this however you want, but please give back any modifications
|
|
|
|
Parts inspired/borrowed/backported from [JEI](https://github.com/mezz/JustEnoughItems/tree/1.12) under the MIT License.
|
|
|
|
Originial code Copyright (c) 2014-2015 mezz and was licensed under the MIT License.
|