diff --git a/README.md b/README.md index ae852279..de7a31b1 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,17 @@ For Afterbirth / Rebirth Version [click here]( https://moddingofisaac.com/mod/1079/external-item-descriptions). ## 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 +- 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 -- 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 +- 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) @@ -35,7 +30,6 @@ https://moddingofisaac.com/mod/1079/external-item-descriptions). ### 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 ?) @@ -58,9 +52,11 @@ Same as Windows but the path is: */home/%YourUsernameHere%/.steam/steam/steamapp ## 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 +- 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 +- 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 diff --git a/eid_config.lua b/eid_config.lua index 39b5bbe1..0988fb3b 100644 --- a/eid_config.lua +++ b/eid_config.lua @@ -2,14 +2,16 @@ EID.DefaultConfig = { -------GENERAL--------- -- Change language of the mod. - -- Currently Supported: English = "en_us" (Default) , "en_us_detailed" - -- French = "fr" SPECIAL THANKS TO Nicolas Delvaux - -- Polish = "pl" SPECIAL THANKS TO Rickyy - -- Spanish = "spa" SPECIAL THANKS TO Lidia Arroyo Purroy - -- Portuguese = "pt" SPECIAL THANKS TO Marcelino Cruz - -- Chinese (https://steamcommunity.com/sharedfiles/filedetails/?id=836319872) - -- Italian (https://steamcommunity.com/sharedfiles/filedetails/?id=931392691) - -- Russian (https://steamcommunity.com/sharedfiles/filedetails/?id=1552851879) + -- Currently Supported: English = "en_us" (Default) , "en_us_detailed" + -- French = "fr" SPECIAL THANKS TO Nicolas Delvaux + -- Polish = "pl" SPECIAL THANKS TO Rickyy (WIP) + -- Spanish = "spa" SPECIAL THANKS TO Lidia Arroyo Purroy + -- Portuguese = "pt" SPECIAL THANKS TO Marcelino Cruz + -- Russian = "ru" SPECIAL THANKS TO hell2pay, fly_6, TrJ-VoRoN + -- Bulgarian = "bul" SPECIAL THANKS TO Gothika_47 (WIP) + -- Turkish = "turkish" SPECIAL THANKS TO Mert Dutal (WIP) + -- Chinese (https://steamcommunity.com/sharedfiles/filedetails/?id=836319872) + -- Italian (https://steamcommunity.com/sharedfiles/filedetails/?id=931392691) -- If you want to make a translation, please contact me :) ["Language"] = "en_us", -- Change font type. Values are [default, borderless, inverted] diff --git a/metadata.xml b/metadata.xml index e85063e2..97279c92 100644 --- a/metadata.xml +++ b/metadata.xml @@ -3,48 +3,57 @@ !External item descriptions external item descriptions 836319872 - This mod displays detailed information about all items, trinkets, cards, runes and pills DIRECTLY onto your screen. Say goodbye to your browsertab with platinumgod open ;) + This mod displays detailed information about all items, trinkets, cards, runes and pills DIRECTLY onto your screen. Say goodbye to your browsertab with platinumgod open ;) [h1][b]------------------FEATURES------------------[/b][/h1] -- 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 +- Displays information for all Collectibles, Trinkets, Cards, Runes, Pills and some Rooms +- Displays [b]additional informations[/b] 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 ([url=https://github.com/wofsauge/External-Item-Descriptions/wiki]Documentation here[/url]) +- A huge amount of custom options like: +---- Indicators +---- Font style +---- Language +---- and a lot of visual options! - [b]Press F2 to hide/show the descriptions![/b] -- 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 ([b]This is enabled on default[/b]) ----- Customizable position, width and scale of the Textbox ----- Modded item support! ----- Custom item descriptions support ----- Custom entity descriptions ----- and much more --- Including the following additional languages: [b]FRENCH[/b](by Nicolas Delvaux), [b]SPANISH[/b] (by Arroyo Purroy), [b]PORTUGUESE[/b] (by Marcelino Cruz) and [b]POLISH[/b] (WIP, by Rickyy) -Change the config.lua file to switch languages. +[h1][b]------------------LANGUAGES------------------[/b][/h1] +[img]https://i.imgur.com/66Ul9Gs.png[/img] +[table] + [tr] + [th]ENGLISH[/th] + [th]SPANISH[/th] + [th]RUSSIAN[/th] + [th]FRENCH[/th] + [th]PORTUGUESE[/th] + [th]BULGARIAN[/th] + [th]TURKISH[/th] + [th]POLISH[/th] + [/tr] + [tr] + [td]by Wofsauge[/td] + [td]by Arroyo Purroy[/td] + [td]by hell2Pay & fly_6 & TrJ-VoRon[/td] + [td]by Nicolas Delvaux[/td] + [td]by Marcelino Cruz[/td] + [td]by Gothika_47[/td] + [td]by Mert Dutal[/td] + [td]by Rickyy[/td] + [/tr] +[/table] --- Click here for the [b]CHINESE[/b] version : [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1290363695]EID Chinese Edition[/url] -- +[img]https://i.imgur.com/J72fl8H.png[/img] [b]CHINESE[/b] version : [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1290363695]EID Chinese Edition[/url] or alternatively [url=https://steamcommunity.com/sharedfiles/filedetails/?id=848295251]中文道具图鉴 Eid Chinese[/url] --- Click here for an alternative [b]CHINESE[/b] version : [url=https://steamcommunity.com/sharedfiles/filedetails/?id=848295251]中文道具图鉴 Eid Chinese[/url] -- - --- Click here for the [b]ITALIAN[/b] version : [url=https://steamcommunity.com/sharedfiles/filedetails/?id=931392691]External Item Descriptions Italian[/url] -- - --- Click here for the [b]RUSSIAN[/b] version : [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1552851879]External Item Description (Russian Language)[/url] -- +[img]https://i.imgur.com/s55wxDG.png[/img] [b]ITALIAN[/b] version : [url=https://steamcommunity.com/sharedfiles/filedetails/?id=931392691]External Item Descriptions Italian[/url] -- -[h1][b]For Afterbirth / Rebirth Version click here: [/b][/h1] -https://moddingofisaac.com/mod/1079/external-item-descriptions - - -[h1]You can use [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1603631350]"Mod config Menu"[/url] to customize this mod![/h1] - -[h1][b]For further Configuration:[/b][/h1] +[h1][b]------------------CONFIGURATION------------------[/b][/h1] +[h1]You can use [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1603631350]"Mod config Menu"[/url] to customize this mod![/h1] +or [b]Windows[/b] 1. Go to ..\Documents\My Games\Binding of Isaac Afterbirth+ Mods\External item descriptions\ -2. Open "config.lua" with any texteditor +2. Open "config.lua" with any texteditor 3. Edit the Config 4. Save the file 5. Play the game @@ -52,14 +61,21 @@ https://moddingofisaac.com/mod/1079/external-item-descriptions [b]Linux / Ubuntu [/b] Same as aboth but the path is: /home/%YourUsernameHere%/.steam/steam/steamapps/workshop/content/250900/836319872 -[h1][b]Special Thanks to[/b][/h1] +[img]https://i.imgur.com/CywNd0N.png[/img] +https://moddingofisaac.com/mod/1079/external-item-descriptions + +[h1][b]------------------SPECIAL THANKS------------------[/b][/h1] - 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 -- [url=https://steamcommunity.com/id/whytefang/]adc[/url] for creating a awesome new Languagepack and providing ideas for new functionalities +- Nicolas Delvaux for creating an awesome [b]French[/b] language pack +- Lidia Arroyo Purroy for creating the amazing [b]Spanish[/b] language Pack +- Rickyy for creating the incredible [b]Polish[/b] language pack +- Marcelino Cruz for creating the [b]Portuguese[/b] language pack +- hell2pay, fly_6, TrJ-VoRoN for creating the [b]Russian[/b] language pack +- Gothika_47 for creating the [b]Bulgarian[/b] language pack +- Mert Dutal for creating the [b]Turkish[/b] language pack +- [url=https://steamcommunity.com/id/whytefang/]adc[/url] for creating an awesome new Languagepack and providing ideas for new functionalities + +[img]https://i.imgur.com/P6a8043.png[/img] [url=https://github.com/wofsauge/External-Item-Descriptions]Any Problems? Visit this project on GitHub[/url] 1.67 Public