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

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:

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