Files
External-Item-Descriptions/README.md
T
kittenchilly e25d55d436 Trailing whitespace cleanup (#600)
* Trailing whitespace cleanup

* More
2023-11-08 07:37:36 +01:00

43 lines
3.1 KiB
Markdown

[![Steam Downloads](https://img.shields.io/steam/downloads/836319872?color=blue&label=Downloads&logo=steam&logoColor=white?label=Steam%20Downloads)](https://steamcommunity.com/sharedfiles/filedetails/?id=836319872) [![Github Downloads](https://img.shields.io/github/downloads/wofsauge/External-Item-Descriptions/total?label=Github%20Downloads)](https://github.com/wofsauge/External-Item-Descriptions) [![Discord](https://img.shields.io/discord/927985880021483571?color=blue&label=Discord&logo=Discord&logoColor=white)](https://discord.gg/435qCC6nHt)
# External Item Descriptions
A mod for the game "The Binding of Isaac: Rebirth" that displays useful information for items, trinkets, rooms and more!
This version is designed to be used with the Afterbirth+ and Repentance DLCs.
## Features
- **Compatible with Afterbirth+ and Repentance**
- Displays information for all collectibles, trinkets, cards, runes, pills, horsepills and some rooms
- Displays **additional information** like item type, charges, transformations, Spindown Dice results, Bag of Crafting recipes, TMTRAINER item effects (Detailed informations require --luadebug flag!), and much much more!
- 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 styles
- 17+ different Languages
- And a lot of visual options!
- **Press F2 to hide/show the descriptions!**
## Supported Languages
Chinese, Czech, Dutch, English, French, German, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Brazilian-Portuguese, Turkish, Ukrainian
## Versions
There are multiple Versions of the mod, depending on which DLCs you have installed. You are currently looking at the version for Afterbirth+ and Repentance.
- Rebirth (no DLCs): [MediaFire](https://www.mediafire.com/download/allrnsejnuwi1lu/External_Item_Descriptions_-_Rebirth.zip)
- Afterbirth (first DLC): [ModdingOfIsaac.com](https://moddingofisaac.com/mod/1079/external-item-descriptions) - [MediaFire mirror](https://www.mediafire.com/file/guxc33u2x252aux/external-item-descriptions_-_Afterbirth_3.7.zip/file)
- Afterbirth+ and Repentance: [Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=836319872) - [GitHub](https://github.com/wofsauge/External-Item-Descriptions/releases)
## Installation
For **Steam users**, simply press the "Subscribe" button on the mod's Steam Workshop page. This will automatically install the mod for you.
For **manual mod installation** or **installation trouble shooting**, read this tutorial "[How to install the mod](https://github.com/wofsauge/External-Item-Descriptions/wiki/How-to-install-the-mod)"
## Configuration
Simply install "[Mod Config Menu - Pure](https://steamcommunity.com/sharedfiles/filedetails/?id=2681875787)". You can use it to configure the mod while playing.
Alternatively, edit the `eid_config.lua` file like described [here.](https://github.com/wofsauge/External-Item-Descriptions/wiki/Edit-the-configuration-manually)
## Special Thanks to
[Check out the credits here](https://github.com/wofsauge/External-Item-Descriptions/blob/master/CREDITS.md)