Skymods

The Binding of Isaac: Rebirth Mods Catalogue

yetanother’s External Item Descriptions

Uploaded ·

If you liked this item, please rate it up on Steam Workshop page.

Author: goki_dev

Last revision: 11 May, 2018 at 12:54 UTC

File size: 69.63 KB

On Steam Workshop

Description:

yetanother’s External Item Descriptions

This mod does NOT have external descriptions by default!
You must install description packs or rely on mod authors to use the API to add them!

Base + More (English)
Base Game (English)

An alternative to Wofsauge’s External Item Descriptions that supports modded items.

If you’d like to use the API to add descriptions to your modded items or to simply create a translation, read the guide, send a message, start a discussion, or check out the basic documentation at the bottom!

Full documentation and code examples found in the guide

Features
  • Can describe Items, Pills, Cards, and Trinkets
  • Supports multiple languages (through workshop mods)
  • Supports images as descriptions
  • API for other mod developers to add descriptions for their custom items
  • Toggle cheating (Ignore Curse of the Blind, Check shop items, unidentified pills)
  • Automatic description fallback for missing definitions (using the game’s base descriptions)
  • Local mode for showing descriptions by the item (with separate text scaling)
  • Item highlighting
  • Text scaling
  • Line colour coding
  • Custom font support
  • Console support
  • etc…

Configuration

To make changes, use the console (` key) and the commands found below.

yaeid set option_name new_value …

For Booleans, value can be true, false, flip, 1, 0, or !
For String, any text can be used
For Numbers, any real number can be used

For example, to turn Local Mode off, open the console and type

yaeid set LocalMode false

To set text Transparency to 50%

yaeid set Transparency 0.5

Valid options and their types:

  • Alignment: Number
  • CenterMetadata: Boolean
  • DefaultFallback: Boolean
  • Font: String
  • HandleCollectibles: Boolean
  • HandleGenerics: Boolean
  • HandlePills: Boolean
  • HandlePocket: Boolean
  • HandleTrinkets: Boolean
  • HighlightTarget: Boolean
  • Language: String
  • LineBreakSize: Number
  • LineSpacing: Number
  • LocalAlignment: Number
  • LocalFont: String
  • LocalMode: Boolean
  • LocalScale: Number
  • MaxDistance: Number
  • PillCheat: Boolean
  • RenderScale: Number
  • RenderTextShadow: Boolean
  • RenderTextShadowTransparency: Number
  • RenderX: Number
  • RenderY: Number
  • ShowAdvancedInfo: Boolean
  • ShowAlways: Boolean
  • ShowBaseDescriptions: Boolean
  • ShowExtraInfo: Boolean
  • ShowIDs: Boolean
  • ShowNames: Boolean
  • ShowTyping: Boolean
  • SixthSense: Boolean
  • Transparency: Number
  • WindowShopper: Boolean

yaeid blacklist target

Blacklists the currently targetted entity so the description won’t show

yaeid blacklist add entityType entityVariant entitySubType

Blacklist a specific entity. Use -1 in place of entityType, entityVariant, or entitySubType to blacklist all entities in that branch.

For example,

` yaeid blacklist 6 -1 -1

blacklists all slot type entities.

yaeid blacklist remove entityType entityVariant entitySubType

Remove an entity from the blacklist

yaeid blacklist list

List all blacklist entries (entityType.entityVariant.entitySubType)

Basic Example

Registering a description is very simple. Here is the code for a barebones mod that adds a description to the Magic Mushroom item:

local MOD = RegisterMod( "YAEID: Example", 1 ) function Register() YAEID:RegisterCollectibles({ {CollectibleType.COLLECTIBLE_MAGIC_MUSHROOM,"A really good item! Pick it up!"} }) end YAEID_QUEUE = YAEID_QUEUE or {} YAEID_QUEUE["example_descriptions"] = Register if YAEID ~= nil then Register() end

yatboim

Download
Required DLC:

These DLC should be installed in order to use this item.


The Binding of Isaac: Afterbirth
The Binding of Isaac: Afterbirth+