Are you tired of interrupting your game to look up something about an item on the wiki?
Are you a new player who needs a few extra hints on what items do?
Then this mod is for you. Inspired by the "External item descriptions" mod for Binding of Isaac. Item Tips also supports custom external description files. See the Custom Descriptions section below.
The mod provides helpful extra tips in-game for all passives, actives, and guns where ever they appear including metashops. The onscreen tip includes:
- Item/Gun Name
- Quality
- Short description including effects like curse and coolness.
- Synergies with an indicator if you will complete the synergy with this item.
Ammonomicon entries are expanded to include:
- Quality
- Short description (same as above)
- Synergies with descriptions
- If you have an external item tips file, the mod which contains the item.
Especially useful for getting some basic info when you don't know an item by sight, like in a rainbow run or haven't unlocked it yet in a metashop. Items that reveal chest contents (e.g. The Exotic) also show tips.
Commands
There are few commands to perform some functions in the mod, they look like this:
itemtips [command] {commandargs}
The commands:
- help {commandname} - prints help about the mod. If an argument is supplied it gives help on the command that is the argument.
Example:itemtips help config
gives help on the config command. - config [setting] [value] - changes configuration setting.
Settings:
tips - controls in-game tips, values: [on/off]
ammonomicon - controls ammonomicon expansion, values: [on/off]
Example:itemtips config tips off
- turns off in-game tips. - reload - reloads external description files.
- generate - generates a sample external description file for all currently loaded items/synergies.
Installation
- Requires ModTheGungeon. Install it first.
- Download the ItemTips main zip. Do NOT unzip it.
- Copy the zip file into the Mods folder.
- Delete mods.txt. (this file will be regenerated automatically the next time you start Enter the Gungeon)
Custom Descriptions
All custom descriptions go into json files in the folder Enter the Gungeon\Resources\itemtips\ext. This folder will be generated for you if you use the command itemtips generate
in the mtg console. To install a custom description file, simply drop the json file in the ext folder and restart the game. Custom descriptions are available for popular mods/item packs:
- [Retrash's] Custom Items Collection (v5.0)
- Expand The Gungeon (v1.9.7)
- Once More Into The Breach (v1.23.1)
- Kyle's Custom Item Pack (v3.2)
- SpecialAPI's Stuff (v.2.2.2)
- Frost and Gunfire (v.1.0.1)
- Planetside of Gunymede (v.1.1.2)
- Cel's Items (v2.4)
- Cutting Room Floor (v3.2)
- Blazeykat's Garbage Item Pack (v.0.1.3)
- Some Bunny's Item Pack (v.1.7.0)
- Enter The Dungeon (v.0.51)
- Fallen Items (v.1.00)
- Hunter's RoR2 and Misc items (v.0.6.1)
- A Bleaker Item Pack (v.0.1.0)
Special thanks to:
- Boomber/DJNotNice for providing the custom descriptions for Expand the Gungeon, Retrash's Items, Frost and Gunfire, Once More Into The Breach, SpecialAPI's Stuff, Planetside of Gunymede, A Bleaker Item Pack and Kyle's Custom Item Pack
- Gigabars for custom descriptions for Cel's Items
- Hotklou for custom descriptions for Cutting Room Floor and Blazeykat's Items
- Some Bunny for custom descriptions for his mod (Some Bunny's Item Pack)
- Lordfortress | Hipster Cat for custom descriptions for Enter The Dungeon and Fallen Items
- bl4ck_hunter for custom descriptions for his mod (Hunter's RoR2 and Misc items)
- SpecialAPI for suggestions and info about cross mod synergies
- Dallan for the custom icon for the mod