Files
External-Item-Descriptions/README.md
T

64 lines
3.1 KiB
Markdown

# 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](
https://moddingofisaac.com/mod/1079/external-item-descriptions).
## FEATURES
- Displays information for all Collectibles, Trinkets, Cards, Runes, Pills and some Rooms
- Displays **additional informations** like Itemtype, Charges, or Transformations
- Display one of 4 different Indicators around the inspected item
- Mod support for nearly all mods!
- Easy to use API ([Documentation here](https://github.com/wofsauge/External-Item-Descriptions/wiki))
- A huge amount of custom options like:
- Indicators
- Font style
- Language
- and a lot of visual options!
- **Press F2 to hide/show the descriptions!**
### Supported Languages
- **English** (Default)
- **FRENCH** (by Nicolas Delvaux)
- **SPANISH** (by Arroyo Purroy)
- **PORTUGUESE** (by Marcelino Cruz)
- **BULGARIAN** (*WIP*, by TST_Gogo_, Gothika_47)
- **POLISH** (*WIP*, by Rickyy)
- **CHINESE** version: [EID Chinese Edition](https://steamcommunity.com/sharedfiles/filedetails/?id=1290363695) | alternative: [中文道具图鉴 Eid Chinese](https://steamcommunity.com/sharedfiles/filedetails/?id=848295251)
- **ITALIAN** version: [External Item Descriptions Italian](https://steamcommunity.com/sharedfiles/filedetails/?id=931392691)
- **RUSSIAN** version: [External Item Description (Russian Language)](https://steamcommunity.com/sharedfiles/filedetails/?id=1552851879)
### Possible Future Features
- Support for the new DLC **Repentance** (With backwards compatibility)
- 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](https://steamcommunity.com/sharedfiles/filedetails/?id=1603631350)". 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
- Nicolas Delvaux for creating an awesome **French** language pack
- Lidia Arroyo Purroy for creating the amazing **Spanish** language Pack
- Rickyy for creating the incredible **Polish** language pack
- Marcelino Cruz for creating the **Portuguese** language pack
- hell2pay, fly_6, TrJ-VoRoN for creating the **Russian** language pack
- TST_Gogo_, Gothika_47 for creating the **Bulgarian** language pack
- Mert Dutal for creating the **Turkish** language pack
- [adc](https://steamcommunity.com/id/whytefang/) for creating a awesome new Languagepack and providing ideas for new functionalities