lzrdblzzrd/External-Item-Descriptions
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add better formatting and grammar fixes

Browse Source
This commit is contained in:
Marcx committed 2021-10-22 00:46:59 +02:00
1 parent 39ef7c97f2
commit 57e69ba89e
1 file changed
+35 -34
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+35 -34
View File
@@ -1,14 +1,14 @@
# External Item Descriptions # External Item Descriptions
A mod for the game "The Binding of Isaac: Rebirth" that displays useful informations for items, trinkets, rooms and more! A mod for the game "The Binding of Isaac: Rebirth" that displays useful information for items, trinkets, rooms and more!
The current version is designed to be used with the Afterbirth+ and Repentance DLC. The current version is designed to be used with the Afterbirth+ and Repentance DLC.
For Afterbirth / Rebirth Version [click here]( For the Afterbirth/Rebirth version [click here](https://moddingofisaac.com/mod/1079/external-item-descriptions).
https://moddingofisaac.com/mod/1079/external-item-descriptions).
## FEATURES
- Displays information for all Collectibles, Trinkets, Cards, Runes, Pills and some Rooms ## Features
- Displays **additional informations** like Itemtype, Charges, Transformations, Spindown Dice Results or Bag of Crafting recepies - Displays information for all collectibles, trinkets, cards, runes, pills and some rooms
- Display one of 4 different Indicators around the inspected item - Displays **additional information** like item type, charges, transformations, spindown Dice Results and Bag of Crafting recipes
- Displays one of 4 different indicators around the inspected item
- Mod support for nearly all mods! - Mod support for nearly all mods!
- Easy to use API ([Documentation here](https://github.com/wofsauge/External-Item-Descriptions/wiki)) - Easy to use API ([Documentation here](https://github.com/wofsauge/External-Item-Descriptions/wiki))
- A huge amount of custom options like: - A huge amount of custom options like:
@@ -16,50 +16,51 @@ https://moddingofisaac.com/mod/1079/external-item-descriptions).
- Font style - Font style
- Language - Language
- and a lot of visual options! - and a lot of visual options!
- **Press F2 to hide/show the descriptions!** - **Press F2 to hide/show the description!**
### Supported Languages ### Supported Languages
- **English** (Default) - **English** (Default)
- **FRENCH** (by Nicolas Delvaux) - **French** (by Nicolas Delvaux)
- **SPANISH** (by Arroyo Purroy) - **Spanish** (by Arroyo Purroy)
- **PORTUGUESE** (by Marcelino Cruz) - **Portuguese** (by Marcelino Cruz)
- **Brazilian - Portuguese** (by LuanRoger and NotZin02) - **Brazilian - Portuguese** (by LuanRoger and NotZin02)
- **RUSSIAN** (by hell2Pay, fly_6, Dezzelshipc and Sekaz) - **Russian** (by hell2Pay, fly_6, Dezzelshipc and Sekaz)
- **ITALIAN** (by Klyser8, Denkishi, 2G) - **Italian** (by Klyser8, Denkishi, 2G)
- **BULGARIAN** (*WIP*, by TST_Gogo_, Gothika_47) - **Bulgarian** (*WIP*, by TST_Gogo_, Gothika_47)
- **TURKISH** (by Cagdas Salur, Mert Dutal) - **Turkish** (by Cagdas Salur, Mert Dutal)
- **POLISH** (by Rickyy, Kennyluz, MERITT, DimonoKingoKongo ) - **Polish** (by Rickyy, Kennyluz, MERITT, DimonoKingoKongo )
- **CHINESE** version: [EID Chinese Edition](https://steamcommunity.com/sharedfiles/filedetails/?id=1290363695) | alternative: [中文道具图鉴 Eid Chinese](https://steamcommunity.com/sharedfiles/filedetails/?id=848295251) - **Chinese** version: [EID Chinese Edition](https://steamcommunity.com/sharedfiles/filedetails/?id=1290363695) | alternative: [中文道具图鉴 Eid Chinese](https://steamcommunity.com/sharedfiles/filedetails/?id=848295251)
### Possible Future Features ### Possible Future Features
- Display if items need to be collected for achievement purposes - Display if items need to be collected for achievement purposes
- More Languages! - More languages!
## Configuration ## 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. ### In-game Configuration
**Windows** Simply install "[Mod config Menu](https://steamcommunity.com/sharedfiles/filedetails/?id=1603631350)". All configuration except the language setting can be changed with it in game.
1. With Repentance: steamapps\common\The Binding of Isaac Rebirth\mods\external item descriptions_836319872\
1. With AB+: ..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\ ### Windows
2. Open "config.lua" with any texteditor 1. With Repentance: `steamapps\common\The Binding of Isaac Rebirth\mods\external item descriptions_836319872\`
3. Edit the Config 1. With AB+: `..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\`
2. Open `config.lua` with any text editor
3. Edit the config
4. Save the file 4. Save the file
5. Play the game 5. Play the game
To reset the config delete all the "save[NUMBER].dat" files from the following folder: To reset the config, delete all the "save[NUMBER].dat" files from the following folder:
1. With Repentance: steamapps\common\The Binding of Isaac Rebirth\data\external item descriptions\ 1. With Repentance: `steamapps\common\The Binding of Isaac Rebirth\data\external item descriptions\`
1. With AB+: ..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\ 1. With AB+: `..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\`
**Linux / Ubuntu** ### Linux
Same as Windows, but the path is: `/home/%YourUsernameHere%/.steam/steam/steamapps/workshop/content/250900/836319872`
Same as Windows but the path is: */home/%YourUsernameHere%/.steam/steam/steamapps/workshop/content/250900/836319872*
## Special Thanks to ## Special Thanks to
- The Binding of Isaac wiki and platinumgod.co.uk for providing useful item descriptions - [The Binding of Isaac Wiki](https://bindingofisaacrebirth.fandom.com/wiki/Binding_of_Isaac:_Rebirth_Wiki) and [platinumgod.co.uk](https://platinumgod.co.uk/) for providing useful item descriptions
- Nicolas Delvaux for creating an awesome **French** language pack - Nicolas Delvaux for creating an awesome **French** language pack
- Klyser8, Denkishi and 2G for creating the fantastic **Italian** language pack - Klyser8, Denkishi and 2G for creating the fantastic **Italian** language pack
- Lidia Arroyo Purroy for creating the amazing **Spanish** language Pack - Lidia Arroyo Purroy for creating the amazing **Spanish** language Pack
@@ -70,4 +71,4 @@ Same as Windows but the path is: */home/%YourUsernameHere%/.steam/steam/steamapp
- TST_Gogo_, Gothika_47 for creating the **Bulgarian** language pack - TST_Gogo_, Gothika_47 for creating the **Bulgarian** language pack
- Cagdas Salur and Mert Dutal for creating the **Turkish** language pack - Cagdas Salur and Mert Dutal for creating the **Turkish** language pack
- Jake for the sweet **German** language pack - Jake for the sweet **German** language pack
- [adc](https://steamcommunity.com/id/whytefang/) for creating a awesome new Languagepack and providing ideas for new functionalities - [adc](https://steamcommunity.com/id/whytefang/) for creating an awesome new language pack and providing ideas for new functionalities