From 3a5fa2e6c9de0fed24f8efd56bd67304b9713514 Mon Sep 17 00:00:00 2001 From: Wofsauge Date: Fri, 17 Feb 2023 23:43:25 +0100 Subject: [PATCH] Updated Readmes and created CREDITS file --- CREDITS.md | 26 ++++++++++++++ README.md | 71 +++++++++----------------------------- eid_config.lua | 3 ++ metadata.xml | 94 ++++++++------------------------------------------ 4 files changed, 60 insertions(+), 134 deletions(-) create mode 100644 CREDITS.md diff --git a/CREDITS.md b/CREDITS.md new file mode 100644 index 00000000..dded7511 --- /dev/null +++ b/CREDITS.md @@ -0,0 +1,26 @@ +# Languages +- **Bulgarian**: by TST_Gogo_, Gothika_47 +- **Chinese**: by Xheepey87, frto027 +- **Czech**: by David Kapitančik. Picus, domcizzz +- **Dutch**: by SomethingMax +- **English**: by Wofsauge, Buurazu, Ma-rcx, AutisticGoat, ... +- **French**: by Nicolas Delvaux +- **German**: by Jake +- **Greek**: by vanillarat +- **Italian**: by Klyser8, Denkishi, 2G +- **Japanese**: by prefab +- **Korean**: by Blackcreamtea, 미카 +- **Polish**: by Rickyy, Kennyluz, MERITT, DimonoKingoKongo +- **Portuguese**: by Marcelino Cruz +- **Russian**: by hell2Pay, fly_6, Dezzelshipc and Sekaz +- **Spanish**: by Lidia Arroyo Purroy +- **Brazilian - Portuguese**: by LuanRoger and NotZin02 +- **Turkish**: by Cagdas Salur, Mert Dutal +- **Ukrainian**: by x3xto + + +# Special Thanks to +- [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 +- Buurazu for all the hard work improving the mod :) +- [eyeguy](https://twitter.com/eyeguyart) for creating the astonishing transformation icons +- [adc](https://steamcommunity.com/id/whytefang/) for creating an awesome new language pack and providing ideas for new functionalities diff --git a/README.md b/README.md index 5c08abed..b2f075bc 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,42 @@ -[![Steam Downloads](https://img.shields.io/steam/downloads/836319872?color=blue&label=Downloads&logo=steam&logoColor=white)](https://steamcommunity.com/sharedfiles/filedetails/?id=836319872) -[![Discord](https://img.shields.io/discord/927985880021483571?color=blue&label=Discord&logo=Discord&logoColor=white)](https://discord.gg/435qCC6nHt) +[![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! -The current version is designed to be used with the Afterbirth+ and Repentance DLC. -For the Afterbirth/Rebirth version [click here](https://moddingofisaac.com/mod/1079/external-item-descriptions). - +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! -- Displays 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 styles - - Languages + - 17+ different Languages - 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) -- **Brazilian - Portuguese** (by LuanRoger and NotZin02) -- **Russian** (by hell2Pay, fly_6, Dezzelshipc and Sekaz) -- **Italian** (by Klyser8, Denkishi, 2G) -- **Bulgarian** (*WIP*, by TST_Gogo_, Gothika_47) -- **Turkish** (by Cagdas Salur, Mert Dutal) -- **Polish** (by Rickyy, Kennyluz, MERITT, DimonoKingoKongo) -- **Korean** (by Blackcreamtea, 미카) -- **Czech** (by David Kapitančik. Picus, domcizzz) -- **Chinese** (by Xheepey87, frto027) Alternative versions: [EID Chinese Edition](https://steamcommunity.com/sharedfiles/filedetails/?id=1290363695) | [中文道具图鉴 Eid Chinese](https://steamcommunity.com/sharedfiles/filedetails/?id=848295251) +## 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 -### In-game Configuration - Simply install "[Mod Config Menu - Pure](https://steamcommunity.com/sharedfiles/filedetails/?id=2681875787)". You can use it to configure the mod while playing. -Or: -### Windows -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\` -2. Open `eid_config.lua` with any text editor -3. Edit the config -4. Save the file -5. Play the game - -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 AB+: `..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\` - -### Linux - -Same as Windows, but the path is: `/home/%YourUsernameHere%/.steam/steam/steamapps/workshop/content/250900/836319872` +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 -- [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 -- [eyeguy](https://twitter.com/eyeguyart) for creating the astonishing transformation icons -- Nicolas Delvaux for creating an awesome **French** language pack -- Klyser8, Denkishi and 2G for creating the fantastic **Italian** language pack -- Lidia Arroyo Purroy for creating the amazing **Spanish** language Pack -- Rickyy, Kennyluz, DimonoKingoKongo and MERITT for creating the incredible **Polish** language pack -- Marcelino Cruz for creating the **Portuguese** language pack -- LuanRoger and NotZin02 for creating the **Brazilian - Portuguese** language pack -- hell2pay, fly_6, Dezzelshipc and Sekaz for creating the **Russian** language pack -- Gothika_47 and TST_Gogo_ for creating the **Bulgarian** language pack -- Cagdas Salur and Mert Dutal for creating the **Turkish** language pack -- Jake for the sweet **German** language pack -- Blackcreamtea and 미카 for the awesome **Korean** language pack -- prefab for the incredible **Japanese** language pack -- David Kapitančik. Picus and domcizzz for the cool **Czech** language pack -- [adc](https://steamcommunity.com/id/whytefang/) for creating an awesome new language pack and providing ideas for new functionalities +[Check out the credits here](https://github.com/wofsauge/External-Item-Descriptions/blob/master/CREDITS.md) diff --git a/eid_config.lua b/eid_config.lua index 37c3a8e5..8dee6772 100644 --- a/eid_config.lua +++ b/eid_config.lua @@ -5,9 +5,11 @@ EID.UserConfig = { -- Bulgarian = "bul" SPECIAL THANKS TO Gothika_47 -- Chinese = "zh_cn" SPECIAL THANKS TO Xheepey87, frto027 -- Czech = "cs_cz" SPECIAL THANKS TO domcizzz + -- Dutch = "nl_nl" SPECIAL THANKS TO SomethingMax -- English = "en_us", "en_us_detailed" (More detailed descriptions) -- French = "fr" SPECIAL THANKS TO Nicolas Delvaux -- German = "de" SPECIAL THANKS TO Jake + -- Greek = "el_gr" SPECIAL THANKS TO vanillarat -- Italian = "it" SPECIAL THANKS TO Denkishi, 2G -- Japanese = "ja_jp" SPECIAL THANKS TO prefab -- Korean = "ko_kr" SPECIAL THANKS TO Blackcreamtea, 미카 @@ -17,6 +19,7 @@ EID.UserConfig = { -- Russian = "ru" SPECIAL THANKS TO hell2pay, fly_6 -- Spanish = "spa" SPECIAL THANKS TO Lidia Arroyo Purroy -- Turkish = "tr_tr" SPECIAL THANKS TO Mert Dutal + -- Ukrainian = "uk_ua" SPECIAL THANKS TO x3xto -- -- If you want to make a translation, please contact me :) (wofsauge) -- diff --git a/metadata.xml b/metadata.xml index 4a1e61f3..6b46135f 100644 --- a/metadata.xml +++ b/metadata.xml @@ -14,14 +14,13 @@ This mod displays detailed information about all items, trinkets, cards, runes a [*] [b]Compatible with Afterbirth+ and Repentance[/b] [*] Displays information for all collectibles, trinkets, cards, runes, pills, horsepills and some rooms [*] Displays [b]additional information[/b] like item type, charges, transformations, Spindown Dice results, Bag of Crafting recipes, TMTRAINER item effects (Detailed informations require --luadebug flag!), and much much more! -[*] Displays one of 4 different indicators around the inspected item [*] Mod support for nearly all mods! [*] Easy to use API ([url=https://github.com/wofsauge/External-Item-Descriptions/wiki]Documentation here[/url]) [*] A huge amount of custom options like: [list] [*] Indicators [*] Font styles -[*] Languages +[*] 17+ Languages [*] And a lot of visual options! [/list] [/list] @@ -29,91 +28,28 @@ This mod displays detailed information about all items, trinkets, cards, runes a [b]Press F2 to hide/show the descriptions![/b] [img]https://i.imgur.com/NqSBJqj.png[/img] -[img]https://i.imgur.com/5sky3hP.png[/img] -[table] -[tr] -[th]ENGLISH[/th] -[th]SPANISH[/th] -[th]RUSSIAN[/th] -[th]ITALIAN[/th] -[th]FRENCH[/th] -[th]PORTUGUESE[/th] -[th]BRAZILIAN PORTUGUESE[/th] -[/tr] -[tr] -[td]by Wofsauge[/td] -[td]by Arroyo Purroy[/td] -[td]by hell2Pay, fly_6, Dezzelshipc, Sekaz[/td] -[td]by Klyser8, Denkishi, 2G[/td] -[td]by Nicolas Delvaux[/td] -[td]by Marcelino Cruz[/td] -[td]by LuanRoger, NotZin02[/td] -[/tr][tr] -[th]GERMAN[/th] -[th]BULGARIAN[/th] -[th]TURKISH[/th] -[th]POLISH[/th] -[th]KOREAN[/th] -[th]CHINESE[/th] -[th]JAPANESE[/th] -[/tr] -[tr] -[td]by Jake[/td] -[td]by TST_Gogo_, Gothika_47[/td] -[td]by Cagdas Salur, Mert Dutal[/td] -[td]by Rickyy, Kennyluz, DimonoKingoKongo, MERITT[/td] -[td]by Blackcreamtea, 미카[/td] -[td]by Xheepey87, frto027[/td] -[td]by prefab[/td] -[/tr] -[tr] -[th]CZECH[/th] -[/tr] -[tr] -[td]by David Kapitančik. Picus, domcizzz[/td] -[/tr] -[/table] +[img]https://i.imgur.com/mJshXnR.png[/img] +Supported Languages: +Chinese, Czech, Dutch, English, French, German, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Brazilian-Portuguese, Turkish, Ukrainian +[img]https://i.imgur.com/RVtZEqp.png[/img] +For [b]Steam users[/b], simply press the "Subscribe" button on the mod's Steam Workshop page. This will automatically install the mod for you. +For [b]manual mod installation[/b], read this tutorial "[url=https://github.com/wofsauge/External-Item-Descriptions/wiki/How-to-install-the-mod]How to install the mod[/url]" +If you have problems installing use the [url=https://wofsauge.github.io/IsaacDocs/rep/faq/interactive_FAQ.html]Interactive FAQ[/url]. [img]https://i.imgur.com/PFTZnfC.png[/img] Simply install [url=https://steamcommunity.com/sharedfiles/filedetails/?id=2681875787]'Mod Config Menu Pure'[/url]. You can use it to configure the mod while playing. -Or: +Alternatively, edit the `eid_config.lua` file like described [url=https://github.com/wofsauge/External-Item-Descriptions/wiki/Edit-the-configuration-manually]here[/url] -[h1]Windows[/h1] -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\ -2. Open "eid_config.lua" with any texteditor -3. Edit the config -4. Save the file -5. Play the game +[img]https://i.imgur.com/vUP4whT.png[/img] +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. -To reset the config to default, 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 AB+: ..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\ - -[h1]Linux[/h1] -Same as Windows, but the path is: /home/%Username%/.steam/steam/steamapps/workshop/content/250900/836319872 - -[img]https://i.imgur.com/CywNd0N.png[/img] -https://moddingofisaac.com/mod/1079/external-item-descriptions +[url=https://github.com/wofsauge/External-Item-Descriptions#versions]Alternative versions for all other DLCs, or for manual installation purposes can be found here[/url] [img]https://i.imgur.com/jrdGbna.png[/img] -- The Binding of Isaac Wiki and platinumgod.co.uk for providing useful item descriptions -- [eyeguy][url=https://twitter.com/eyeguyart][/url] for creating the astonishing transformation icons -- Nicolas Delvaux for creating an awesome [b]French[/b] language pack -- Klyser8, Denkishi and 2G for creating the fantastic [b]Italian[/b] language pack -- Lidia Arroyo Purroy for creating the amazing [b]Spanish[/b] language Pack -- Rickyy, Kennyluz, DimonoKingoKongo and MERITT for creating the incredible [b]Polish[/b] language pack -- Marcelino Cruz for creating the [b]Portuguese[/b] language pack -- LuanRoger and NotZin02 for creating the [b]Brazilian - Portuguese[/b] language pack -- hell2pay, fly_6, Dezzelshipc and Sekaz for creating the [b]Russian[/b] language pack -- Gothika_47 and TST_Gogo_ for creating the [b]Bulgarian[/b] language pack -- Cagdas Salur and Mert Dutal for creating the [b]Turkish[/b] language pack -- Jake for the sweet [b]German[/b] language pack -- Blackcreamtea and 미카 for the awesome [b]Korean[/b] language pack -- prefab for the incredible [b]Japanese[/b] language pack -- David Kapitančik. Picus and domcizzz for the cool [b]Czech[/b] language pack -- [url=https://steamcommunity.com/id/whytefang/]adc[/url] for creating an awesome new Languagepack and providing ideas for new functionalities +[url=https://github.com/wofsauge/External-Item-Descriptions/blob/master/CREDITS.md]Check out the credits here[/url] + 4.52 Public