External-Item-Descriptions/README.md

External Item Descriptions

A mod for the game "The Binding of Isaac: Rebirth" that displays useful informations for items, trinkets, rooms and more!

The current version is designed to be used with the Afterbirth+ DLC. For Afterbirth / Rebirth Version click here.

FEATURES

• Displays information for ALL 552 Collectibles, 128 Trinkets, cards, Runes and Pills in the game, including afterbirth+ and all boosterpacks (#1 - #5)
• Displays if an item is needed for a transformation
• Displays the Name and Type (Active / Familiar) of any collectible
• Displays how many charges an item has
• Display one of 4 different Indicators around the inspected item
• Press F2 to hide/show the descriptions!
• Displays what the next payout of the Sacrifice room can be
• Displays a description of the effect of dice-rooms
• Fully customize-able including features like:
  • Custom language support
  • Disabling the descriptions, when Curse of the blind is active (This is enabled on default)
  • Customizable position, width and scale of the Textbox
  • Modded item support!
  • Custom item descriptions support
  • Custom entity descriptions
  • and much more

Supported Languages

• English (Default)
• FRENCH (by Nicolas Delvaux)
• SPANISH (by Arroyo Purroy)
• PORTUGUESE (by Marcelino Cruz)
• POLISH (WIP, by Rickyy)
• CHINESE version: EID Chinese Edition | alternative: 中文道具图鉴 Eid Chinese
• ITALIAN version: External Item Descriptions Italian
• RUSSIAN version: External Item Description (Russian Language)

Possible Future Features

• Support for the new DLC Repentance (With backwards compatibility)
• Better font to support more special characters
• Display if items need to be collected for achievement purposes
• Change location of description so it sticks to the highlighted object
• More Languages! (Language mod unification ?)

Configuration

Ingame Configuration

Simply install "Mod config Menu". All Configurations except the language Setting can be changed with it ingame.

Windows

1. Go to ..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\
2. Open "config.lua" with any texteditor
3. Edit the Config
4. Save the file
5. Play the game

Linux / Ubuntu

Same as Windows but the path is: /home/%YourUsernameHere%/.steam/steam/steamapps/workshop/content/250900/836319872

Special Thanks to

• PLATINUMGOD.CO.UK for providing useful item descriptions
• r0_0t for the functionality to read pill effects and for implementing the modded item-Support
• Nicolas Delvaux for creating an awesome french language pack
• Lidia Arroyo Purroy for creating the amazing spanish spanish language Pack
• Rickyy for creating the incredible polish language pack
• Marcelino Cruz for creating the portuguese language pack
• adc for creating a awesome new Languagepack and providing ideas for new functionalities