Markup - wofsauge/External-Item-Descriptions GitHub Wiki
EID uses a custom developed markup language to format rendered texts and add inline icons, custom colors and effects.
Markup usage
{{Heart}}
= 
Example: All markup objects start with an {{
indicator, followed by the name of the markup object, and finished off with an }}
indicator.
!! Markup is Case Sensitive !!
Markup shortcuts
Some frequently used markup objects do have shortcut representations to make it easier to write descriptions.
Shortcuts:
\1
or↑
= {{ArrowUp}} = Green "positive" arrow icon\2
or↓
= {{ArrowDown}} = Red "negative" arrow icon\3
or!!!
= {{Warning}} = Yellow "warning" exclamation icon{{CR}}
= {{ColorReset}} = Color reset (see Color Paragraph)\7
or\007
= Bulletpoint character (circle)ǂ
= {{Hashtag}} = adds a # Hashtag into the description without causing the start of a new line- {{Blank}} = Invisible Icon
Colors
Colors are
{{ColorRed}}
= Colors the following text red
Example: {{CR}}
or {{ColorReset}}
= Can be used to reset a color back to the color the line was started with
Markup | {{ColorText}} | {{ColorTransform}} | {{ColorError}} | {{ColorObjName}} | {{ColorReset}} |
---|---|---|---|---|---|
Effect | Default text color | Default transformation color | Default error color | Default name color | Used to reset preceeding colors |
Markup | {{ColorBlack}} | {{ColorWhite}} | {{ColorRed}} | {{ColorLime}} | {{ColorBlue}} | {{ColorYellow}} | {{ColorCyan}} |
---|---|---|---|---|---|---|---|
Effect | Black | White | Red | Lime | Blue | Yellow | Cyan |
Markup | {{ColorPink}} | {{ColorSilver}} | {{ColorGray}} | {{ColorMaroon}} | {{ColorOlive}} | {{ColorGreen}} | {{ColorPurple}} |
---|---|---|---|---|---|---|---|
Effect | Pink | Silver | Gray | Maroon | Olive | Green | Purple |
Markup | {{ColorTeal}} | {{ColorNavy}} | {{ColorOrange}} |
---|---|---|---|
Effect | Teal | Navy | Orange |
Special Colors
The following colors are animated text effects. Blink and Fade can also be colored as seen in the example aboth, since they act as a secondary effect. They can therefore the combined with other colors or effects.
Markup | {{ColorRainbow}} | {{ColorBlink}} | {{ColorFade}} |
---|---|---|---|
Effect | Rainbow effect | Text blinks in an interval | Texts fades in and out |
Icons
Important Icons
Markup | {{ERROR}} | {{ArrowUp}} | {{ArrowDown}} | {{Warning}} | {{Blank}} |
---|---|---|---|---|---|
Icon | ![]() |
![]() |
![]() |
![]() |
(No icon) |
Dynamic Icons
Its possible to render specific item icons as well, using the following markup and replacing the [ITEMID]
with the desired id of the item to render.
Modded items work, too, but make sure to use the an dynamic itemid definition like this:
local itemId = Isaac.GetItemIdByName("My Item")
local myDescription = "Some text with my item icon {{Collectible"..itemId .."}}"
Example: {{Collectible1}}
will render the "Sad Onion" as an icon
Markup | {{Collectible}} | {{Collectible[ITEMID]}} | {{Trinket}} | {{Trinket[ITEMID]}} | {{Card[ITEMID]}} | {{Pill[ITEMID]}} |
---|---|---|---|---|---|---|
Icon | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
(*) Cardfront and Pillcolor Sprites are not dynamic. New ones need to be added manually. See this Tutorial for help: Adding Pillcolors and Cardfront sprites
CardIDs:
PillIDs:
Numbers
Markup | {{0}} | {{1}} | {{2}} | {{3}} | {{4}} | {{5}} | {{6}} | {{7}} | {{8}} | {{9}} | {{10}} | {{11}} | {{12}} |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Icon | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Behaviors
Markup | Icon |
---|---|
{{Throwable}} | ![]() |
{{Chargeable}} | ![]() |
Quality
Markup | Icon |
---|---|
{{Quality0}} | ![]() |
{{Quality1}} | ![]() |
{{Quality2}} | ![]() |
{{Quality3}} | ![]() |
{{Quality4}} | ![]() |
Hearts
Markup | Icon |
---|---|
{{Heart}} | ![]() |
{{HalfHeart}} | ![]() |
{{EthernalHeart}} | ![]() |
{{EmptyHeart}} | ![]() |
{{BlendedHeart}} | ![]() |
{{BoneHeart}} | ![]() |
{{HalfBoneHeart}} | ![]() |
{{EmptyBoneHeart}} | ![]() |
{{SoulHeart}} | ![]() |
{{HalfSoulHeart}} | ![]() |
{{BlackHeart}} | ![]() |
{{HalfBlackHeart}} | ![]() |
{{GoldenHeart}} | ![]() |
{{CoinHeart}} | ![]() |
{{HalfCoinHeart}} | ![]() |
{{EmptyCoinHeart}} | ![]() |
{{RottenHeart}} | ![]() |
{{BrokenHeart}} | ![]() |
{{RottenBoneHeart}} | ![]() |
{{UnknownHeart}} | ![]() |
{{HolyMantleSmall}} | ![]() |
{{HolyMantle}} | ![]() |
Pickups
Markup | Icon |
---|---|
{{Key}} | ![]() |
{{GoldenKey}} | ![]() |
{{Bomb}} | ![]() |
{{GoldenBomb}} | ![]() |
{{Coin}} | ![]() |
{{Rune}} | ![]() |
{{Card}} | ![]() |
{{RedCard}} | ![]() |
{{Pill}} | ![]() |
{{Battery}} | ![]() |
{{PoopPickup}} | ![]() |
{{GrabBag}} | ![]() |
{{BlackSack}} | ![]() |
Machines
Markup | Icon |
---|---|
{{Slotmachine}} | ![]() |
{{BloodDonationMachine}} | ![]() |
{{FortuneTeller}} | ![]() |
{{Confessional}} | ![]() |
{{DonationMachine}} | ![]() |
{{RestockMachine}} | ![]() |
{{Mirror}} | ![]() |
{{CraneGame}} | ![]() |
Beggars
Markup | Icon |
---|---|
{{Beggar}} | ![]() |
{{DemonBeggar}} | ![]() |
{{BatteryBeggar}} | ![]() |
{{KeyBeggar}} | ![]() |
{{BombBeggar}} | ![]() |
{{RottenBeggar}} | ![]() |
Chests
Markup | Icon |
---|---|
{{Chest}} | ![]() |
{{GoldenChest}} | ![]() |
{{RedChest}} | ![]() |
{{SpikedChest}} | ![]() |
{{TrapChest}} | ![]() |
{{HolyChest}} | ![]() |
{{WoodenChest}} | ![]() |
{{StoneChest}} | ![]() |
{{HauntedChest}} | ![]() |
{{DirtyChest}} | ![]() |
{{MegaChest}} | ![]() |
Room & Map Icons
Markup | Icon |
---|---|
{{Shop}} | ![]() |
{{SecretRoom}} | ![]() |
{{SuperSecretRoom}} | ![]() |
{{Library}} | ![]() |
{{TreasureRoom}} | ![]() |
{{AngelRoom}} | ![]() |
{{DevilRoom}} | ![]() |
{{MiniBoss}} | ![]() |
{{BossRoom}} | ![]() |
{{ChallengeRoom}} | ![]() |
{{BossRushRoom}} | ![]() |
{{CursedRoom}} | ![]() |
{{SacrificeRoom}} | ![]() |
{{ArcadeRoom}} | ![]() |
{{GreedTreasureRoom}} | ![]() |
{{DiceRoom}} | ![]() |
{{ChestRoom}} | ![]() |
{{IsaacsRoom}} | ![]() |
{{BarrenRoom}} | ![]() |
{{UltraSecretRoom}} | ![]() |
{{Planetarium}} | ![]() |
{{MirrorRoom}} | ![]() |
{{MinecartRoom}} | ![]() |
{{LadderRoom}} | ![]() |
{{PoopRoomIcon}} | ![]() |
{{RedChestRoomIcon}} | ![]() |
{{GoldenChestRoomIcon}} | ![]() |
{{ChestRoomIcon}} | ![]() |
{{StoneChestRoomIcon}} | ![]() |
{{SpikedChestRoomIcon}} | ![]() |
{{HolyChestRoomIcon}} | ![]() |
{{WoodenChestRoomIcon}} | ![]() |
{{MegaChestRoomIcon}} | ![]() |
Stats
Markup | Icon | Markup | Icon | Markup | Icon |
---|---|---|---|---|---|
{{Damage}} | ![]() |
{{DamageSmall}} | ![]() |
{{DamageAB}} | ![]() |
{{Speed}} | ![]() |
{{SpeedSmall}} | ![]() |
{{SpeedAB}} | ![]() |
{{Tears}} | ![]() |
{{TearsSmall}} | ![]() |
{{TearsAB}} | ![]() |
{{Range}} | ![]() |
{{RangeSmall}} | ![]() |
{{RangeAB}} | ![]() |
{{Shotspeed}} | ![]() |
{{ShotspeedSmall}} | ![]() |
{{ShotspeedAB}} | ![]() |
{{Luck}} | ![]() |
{{LuckSmall}} | ![]() |
{{LuckAB}} | ![]() |
{{AngelChance}} | ![]() |
{{AngelChanceSmall}} | ![]() |
{{AngelChanceAB}} | ![]() |
{{DevilChance}} | ![]() |
{{DevilChanceSmall}} | ![]() |
{{DevilChanceAB}} | ![]() |
{{AngelDevilChance}} | ![]() |
{{AngelDevilChanceSmall}} | ![]() |
None | X |
{{PlanetariumChance}} | ![]() |
{{PlanetariumChanceSmall}} | ![]() |
None | X |
{{TreasureRoomChance}} | ![]() |
{{TreasureRoomChanceSmall}} | ![]() |
None | X |
{{Tearsize}} | ![]() |
{{TearsizeSmall}} | ![]() |
{{TearsizeAB}} | ![]() |
Status effects
Markup | Icon |
---|---|
{{DeathMark}} | ![]() |
{{Magnetize}} | ![]() |
{{Slow}} | ![]() |
{{Confusion}} | ![]() |
{{Crown}} | ![]() |
{{Burning}} | ![]() |
{{BrimstoneCurse}} | ![]() |
{{BleedingOut}} | ![]() |
{{Bait}} | ![]() |
{{Charm}} | ![]() |
{{Fear}} | ![]() |
{{Weakness}} | ![]() |
{{Freezing}} | ![]() |
{{Poison}} | ![]() |
Curses
Markup | Icon | Markup | Icon |
---|---|---|---|
{{CurseDarkness}} | ![]() |
{{CurseDarknessSmall}} | ![]() |
{{CurseLabyrinth}} | ![]() |
{{CurseLabyrinthSmall}} | ![]() |
{{CurseLost}} | ![]() |
{{CurseLostSmall}} | ![]() |
{{CurseUnknown}} | ![]() |
{{CurseUnknownSmall}} | ![]() |
{{CurseCursed}} | ![]() |
{{CurseCursedSmall}} | ![]() |
{{CurseMaze}} | ![]() |
{{CurseMazeSmall}} | ![]() |
{{CurseBlind}} | ![]() |
{{CurseBlindSmall}} | ![]() |
{{CurseGiant}} | ![]() |
{{CurseGiantSmall}} | ![]() |
Major bosses
Markup | Icon | Markup | Icon |
---|---|---|---|
{{MomBoss}} | ![]() |
{{MomBossSmall}} | ![]() |
{{MomsHeart}} | ![]() |
{{MomsHeartSmall}} | ![]() |
{{Satan}} | ![]() |
{{SatanSmall}} | ![]() |
{{Isaac}} | ![]() |
{{IsaacSmall}} | ![]() |
{{Delirium}} | ![]() |
{{DeliriumSmall}} | ![]() |
{{Hush}} | ![]() |
{{HushSmall}} | ![]() |
{{Mother}} | ![]() |
{{MotherSmall}} | ![]() |
{{BlueBaby}} | ![]() |
{{BlueBabySmall}} | ![]() |
{{TheLamb}} | ![]() |
{{TheLambSmall}} | ![]() |
{{MegaSatan}} | ![]() |
{{MegaSatanSmall}} | ![]() |
Miscellaneous icons
Markup | Icon | Markup | Icon |
---|---|---|---|
{{Timer}} | ![]() |
{{TimerSmall}} | ![]() |
{{HardMode}} | ![]() |
{{HardModeSmall}} | ![]() |
{{GreedMode}} | ![]() |
{{GreedModeSmall}} | ![]() |
{{GreedierMode}} | ![]() |
{{GreedierModeSmall}} | ![]() |
{{AchievementLocked}} | ![]() |
{{AchievementLockedSmall}} | ![]() |
{{VictoryLap}} | ![]() |
{{VictoryLapSmall}} | ![]() |
{{DailyRun}} | ![]() |
{{DailyRunSmall}} | ![]() |
{{DonationMachineJam}} | ![]() |
{{Trophy}} | ![]() |
Transformation Icons
Any Icon can be used as a Transformation icon. See more details on that topic in the "Add transformations" topic
Markup | Icon |
---|---|
{{CustomTransformation}} | ![]() |
{{Guppy}} | ![]() |
{{LordoftheFlies}} | ![]() |
{{FunGuy}} | ![]() |
{{Seraphim}} | ![]() |
{{Bob}} | ![]() |
{{Spun}} | ![]() |
{{Mom}} | ![]() |
{{Conjoined}} | ![]() |
{{Leviathan}} | ![]() |
{{OhCrap}} | ![]() |
{{Bookworm}} | ![]() |
{{SpiderBaby}} | ![]() |
{{SuperBum}} | ![]() |
{{Stompy}} | ![]() |
{{Adult}} | ![]() |
Room shape Icons
Markup | Icon |
---|---|
{{Room}} | ![]() |
{{RoomSmallHorizontal}} | ![]() |
{{RoomSmallVertical}} | ![]() |
{{RoomLongVertical}} | ![]() |
{{RoomLongHorizontal}} | ![]() |
{{RoomLongThinVertical}} | ![]() |
{{RoomLongThinHorizontal}} | ![]() |
{{RoomXL}} | ![]() |
{{RoomL}} | ![]() |
{{RoomLTopLeft}} | ![]() |
{{RoomLBottomLeft}} | ![]() |
{{RoomLBottomRight}} | ![]() |
Player Icons
Player Icons are defined by {{Player[PlayerType]}}
Markup | Icon | Markup | Icon | Markup | Icon |
---|---|---|---|---|---|
{{Player0}} | {{Player21}} | ||||
{{Player1}} | {{Player22}} | ||||
{{Player2}} | {{Player23}} | ||||
{{Player3}} | {{Player12}} {{Player24}} | ||||
{{Player4}} | {{Player25}} | ||||
{{Player5}} | {{Player26}} | ||||
{{Player6}} | {{Player27}} | ||||
{{Player7}} | {{Player28}} | ||||
{{Player8}} {{Player11}} | {{Player29}} | {{Player38}} | |||
{{Player9}} | {{Player30}} | ||||
{{Player10}} | {{Player31}} | ||||
{{Player13}} | {{Player32}} | ||||
{{Player14}} | {{Player33}} | ||||
{{Player15}} | {{Player34}} | ||||
{{Player16}} | {{Player17}} | {{Player35}} {{Player40}} | |||
{{Player18}} | {{Player36}} | ||||
{{Player19}} | {{Player37}} | ||||
{{Player20}} | {{Player39}} |
Itempools
Markup | Icon |
---|---|
{{ItemPoolTreasure}} | |
{{ItemPoolShop}} | |
{{ItemPoolBoss}} | |
{{ItemPoolDevil}} | |
{{ItemPoolAngel}} | |
{{ItemPoolSecret}} | |
{{ItemPoolLibrary}} | |
{{ItemPoolShellGame}} | |
{{ItemPoolGoldenChest}} | |
{{ItemPoolRedChest}} | |
{{ItemPoolBeggar}} | |
{{ItemPoolDemonBeggar}} | |
{{ItemPoolCurse}} | |
{{ItemPoolKeyMaster}} | |
{{ItemPoolBombBum}} | |
{{ItemPoolMomsChest}} | |
{{ItemPoolGreedTreasure}} | |
{{ItemPoolGreedShop}} | |
{{ItemPoolGreedBoss}} | |
{{ItemPoolGreedDevil}} | |
{{ItemPoolGreedAngel}} | |
{{ItemPoolGreedCurse}} | |
{{ItemPoolGreedSecret}} | |
{{ItemPoolCraneGame}} | |
{{ItemPoolUltraSecret}} | |
{{ItemPoolBatteryBum}} | |
{{ItemPoolPlanetarium}} | |
{{ItemPoolOldChest}} | |
{{ItemPoolBabyShop}} | |
{{ItemPoolWoodenChest}} | |
{{ItemPoolRottenBeggar}} |