wofsauge/external-item-descriptions

A mod for the game "The Binding of Isaac: Rebirth" that displays useful informations for items, trinkets, rooms and more!

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 REPENTOGON installed!), and much much more!
• Mod support for nearly all mods!
• Extended features available with Repentogon
• Easy to use API (Documentation here)
• 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
• Afterbirth (first DLC): ModdingOfIsaac.com - MediaFire mirror
• Afterbirth+ and Repentance: Steam Workshop - GitHub

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"

Configuration

Simply install "Mod Config Menu - Pure". You can use it to configure the mod while playing.

Alternatively, edit the eid_config.lua file like described here.

Special Thanks to

Check out the credits here

external-item-descriptions's Issues

Fix size of Cardfront rune sprites

Font with and without border

Migrate to new Mod config menu API

Check Translations still working with 3.0

Test adding Blank Line to description

Sacrifice room progress increases when invulnerable

Implement new "AddDescription" Methods

Option to change display name to english

Options:
Language
English,
Both

Update languages to have 4 table entries (+transformations + name)

animated icons

Collectible icons markup

Fix line length calculations which include shortcuts

Fix transparency with textcolor

Multiple transformations

requested by Xalum (Pumpkin Gang)

Fix Config saving with mod compat hack

translated names for any item

Test: Adding multiple custom Transformations to an item

Priority information in Docs

New Method > old method > Default > Item XML Description

Website for croudsourced translating?

random item + image + english description + language chooser

add icon function

add color function

Fix text scaling

# in text

requested by Xalum (Pumpkin Gang)

Reimplement Descriptions using getData()

Document Card / pill icons and how to add your own

Fix bulgarian Language pack encoding

Hud Offset support for MCM

Cardfaces and pills as icons

Add Function to check, if description is displayed

Update Workshop Page

use markup in default descriptions

Replace old Special icon mark ups with new ones automatically

append/remove transformation

Add option to display item icon next to name

Add demo-description when in Mod config menu

Function: Get item Icon

Fallback = first markup in itemname

Fix modded descriptions with new datahandling

API: Render Text with Textcolor

current method:
local color = EIDConfig["TextColor"]
EIDConfig["TextColor"] = {1, 0.5, 0}
printBulletPoints("Flareon synergy!", pos.Y + 11 * 6)
EIDConfig["TextColor"] = color

should be in a single function

option to change color of text objects to markup colors

Russian Translation integration

Communicate with russian guys and see if they are interested in merging

Remove Shadow of Pill sprites

Implement new Description handling

Example:

-- ///// NEW EID DESCRIPTIONS /////
--init EID table
if not __EID_Descriptions then
__EID_Descriptions = {};
end
-- Add descriptions
table.insert(__EID_Descriptions,{"lang","type","id","displayName","description"}) -- syntax
table.insert(__EID_Descriptions,{555,"description"}) -- minimal description, ASSUMES lang = en_us, type = collectible, displayName = ingame name
table.insert(__EID_Descriptions,{"ru", 555, "RUSSIAN NAME", "Some cool description in russian"})-- minimal russian description
table.insert(__EID_Descriptions,{"fr","trinket", 123, "french name", "Some trinket description"})-- trinket in french

Line indicator to visualize described entity

Exception handing when no EID is found in other mod

Check font loading with debugmode on

potential fix to load with debug flag:
local modPath=''
local isluadebug,os=pcall(require,"os")
if isluadebug then
local modfolder='smwrom_2214634210' --release mod folder name, i used mod update to add this
modPath='%systemdrive%\Users\%username%\Documents\"My Games"\"Binding of Isaac Afterbirth+ Mods"\'..modfolder --windows only, sorry, was too lazy to implement unix check
else --your code here
end

seperate Transformation features

Add Transformation
Override
append

decrease size of cyrillic font

WIKI SLAVE ISSUE

Linux Font loading not working for other install locations

Get and set font object functions