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

Example: {{Heart}} = heart icon

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
  • {{IND}} = {{Indent}} = Indents a bullet point. Multiple indent markups in one line can be used to indent a line multiple times

Colors

Colors are

Example: {{ColorRed}} = Colors the following text red

{{CR}} or {{ColorReset}} = Can be used to reset a color back to the color the line was started with

ezgif com-gif-maker (1)

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}} {{ColorPastelBlue}} {{ColorLavender}} {{ColorLightOrange}} {{ColorLightYellow}}
Effect Teal Navy Orange Pastel Blue Lavender Light Orange Light Yellow

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}} {{ColorGold}} {{BlinkYellowGreen}} {{BlinkYellowRed}} {{BlinkGray}} {{BlinkPink}} {{BlinkBlue}} {{BlinkGreen}} {{ColorShinyPurple}} {{BlinkBirthright}}
Effect Rainbow effect Text blinks in an interval Texts fades in and out Gold rainbow color effect Yellow to greenfor positivecar battery effects Yellow to red for negative car battery effects Silver to gray, for Black Feather? Pink for BFFs <3 Blue for Hive Mind Subtle green glow Shiny purple color effect Blink between the two shades of tan on Birthright

Icons

Important Icons

Markup {{ERROR}} {{ArrowUp}} {{ArrowDown}} {{Warning}} {{Blank}}
Icon icon_3_0 icon_3_1 icon_3_2 icon_3_3 (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"collectibles_001_thesadonion as an icon

Markup {{Collectible}} {{Collectible[ITEMID]}} {{Trinket}} {{Trinket[ITEMID]}} {{Card[ITEMID]}} {{Pill[ITEMID]}}
Icon icon_6_2 collectibles_001_thesadonion icon_6_4 trinket_001_swallowedpenny card1 (*) pill1 (*)

(*) Cardfront and Pillcolor Sprites are not dynamic. New ones need to be added manually. See this Tutorial for help: Adding Pillcolors and Cardfront sprites

Icon Backgrounds

Its possible to add background images into dynamic icons, by adding an entry to the EID.MarkupBackgroundKeywords table. Right now, we support "Book of Virtues" as a background image with the keyword Virtues.

To add a background to an icon, simply add the keyword from the table in front of the markup name.

Example: {{VirtuesCollectible655}} =

CardIDs:

cardIDs

PillIDs:

pillIDs

Numbers

Markup {{0}} {{1}} {{2}} {{3}} {{4}} {{5}} {{6}} {{7}} {{8}} {{9}} {{10}} {{11}} {{12}}
Icon numbers_0_0 numbers_0_1 numbers_0_2 numbers_0_3 numbers_0_4 numbers_0_5 numbers_0_6 numbers_0_7 numbers_0_8 numbers_0_9 numbers_0_10 numbers_0_11 numbers_0_12

Behaviors

Markup Icon
{{Throwable}} image
{{Chargeable}} image

Quality

Markup Icon
{{Quality0}} image
{{Quality1}} image
{{Quality2}} image
{{Quality3}} image
{{Quality4}} image

Hearts

Markup Icon
{{Heart}} icon_1_0
{{HalfHeart}} icon_1_1
{{EthernalHeart}} icon_1_2
{{EmptyHeart}} icon_1_3
{{BlendedHeart}} icon_1_4
{{BoneHeart}} icon_1_5
{{HalfBoneHeart}} icon_1_6
{{EmptyBoneHeart}} icon_1_7
{{SoulHeart}} icon_2_0
{{HalfSoulHeart}} icon_2_1
{{BlackHeart}} icon_2_2
{{HalfBlackHeart}} icon_2_3
{{GoldenHeart}} icon_2_4
{{CoinHeart}} icon_2_5
{{HalfCoinHeart}} icon_2_6
{{EmptyCoinHeart}} icon_2_7
{{RottenHeart}} image
{{BrokenHeart}} image
{{RottenBoneHeart}} image
{{UnknownHeart}} image
{{HolyMantleSmall}} image
{{HolyMantle}} image

Pickups

Markup Icon
{{Key}} icon_4_0
{{GoldenKey}} icon_4_1
{{Bomb}} icon_4_2
{{GoldenBomb}} icon_4_3
{{Coin}} icon_4_4
{{Rune}} icon_4_5
{{Card}} icon_4_6
{{RedCard}} icon_4_7
{{Pill}} icon_4_8
{{Battery}} icon_4_9
{{PoopPickup}} icon_4_10
{{GrabBag}} icon_4_11
{{BlackSack}} icon_4_12

Machines

Markup Icon
{{Slotmachine}} icon_6_3
{{BloodDonationMachine}} icon_6_4
{{FortuneTeller}} FortuneTeller
{{Confessional}} image
{{DonationMachine}} image
{{RestockMachine}} image
{{Mirror}} image
{{CraneGame}} image

Beggars

Markup Icon
{{Beggar}} image
{{DemonBeggar}} image
{{BatteryBeggar}} image
{{KeyBeggar}} image
{{BombBeggar}} image
{{RottenBeggar}} image

Chests

Markup Icon
{{Chest}} image
{{GoldenChest}} image
{{RedChest}} image
{{SpikedChest}} image
{{TrapChest}} image
{{HolyChest}} image
{{WoodenChest}} image
{{StoneChest}} image
{{HauntedChest}} image
{{DirtyChest}} image
{{MegaChest}} image

Room & Map Icons

Markup Icon
{{Shop}} icon_5_0
{{SecretRoom}} icon_5_1
{{SuperSecretRoom}} icon_5_2
{{Library}} icon_5_3
{{TreasureRoom}} icon_5_4
{{AngelRoom}} icon_5_5
{{DevilRoom}} icon_5_10
{{MiniBoss}} icon_5_6
{{BossRoom}} icon_5_7
{{ChallengeRoom}} icon_5_8
{{BossRushRoom}} icon_5_9
{{CursedRoom}} icon_6_0
{{SacrificeRoom}} icon_6_1
{{ArcadeRoom}} icon_6_5
{{GreedTreasureRoom}} icon_6_6
{{DiceRoom}} icon_6_7
{{ChestRoom}} icon_6_8
{{IsaacsRoom}} icon_6_9
{{BarrenRoom}} icon_6_10
{{UltraSecretRoom}} image
{{Planetarium}} image
{{MirrorRoom}} image
{{MinecartRoom}} image
{{LadderRoom}} image
{{PoopRoomIcon}} image
{{RedChestRoomIcon}} image
{{GoldenChestRoomIcon}} image
{{ChestRoomIcon}} image
{{StoneChestRoomIcon}} image
{{SpikedChestRoomIcon}} image
{{HolyChestRoomIcon}} image
{{WoodenChestRoomIcon}} image
{{MegaChestRoomIcon}} image

Stats

Markup Icon Markup Icon Markup Icon
{{Damage}} image {{DamageSmall}} image {{DamageAB}} image
{{Speed}} image {{SpeedSmall}} image {{SpeedAB}} image
{{Tears}} image {{TearsSmall}} image {{TearsAB}} image
{{Range}} image {{RangeSmall}} image {{RangeAB}} image
{{Shotspeed}} image {{ShotspeedSmall}} image {{ShotspeedAB}} image
{{Luck}} image {{LuckSmall}} image {{LuckAB}} image
{{AngelChance}} image {{AngelChanceSmall}} image {{AngelChanceAB}} image
{{DevilChance}} image {{DevilChanceSmall}} image {{DevilChanceAB}} image
{{AngelDevilChance}} image {{AngelDevilChanceSmall}} image None X
{{PlanetariumChance}} image {{PlanetariumChanceSmall}} image None X
{{TreasureRoomChance}} image {{TreasureRoomChanceSmall}} image None X
{{Tearsize}} image {{TearsizeSmall}} image {{TearsizeAB}} image

Status effects

Markup Icon
{{DeathMark}} image
{{Magnetize}} image
{{Slow}} image
{{Confusion}} image
{{Crown}} image
{{Burning}} image
{{BrimstoneCurse}} image
{{BleedingOut}} image
{{Bait}} image
{{Charm}} image
{{Fear}} image
{{Weakness}} image
{{Freezing}} image
{{Poison}} image

Curses

Markup Icon Markup Icon
{{CurseDarkness}} image {{CurseDarknessSmall}} image
{{CurseLabyrinth}} image {{CurseLabyrinthSmall}} image
{{CurseLost}} image {{CurseLostSmall}} image
{{CurseUnknown}} image {{CurseUnknownSmall}} image
{{CurseCursed}} image {{CurseCursedSmall}} image
{{CurseMaze}} image {{CurseMazeSmall}} image
{{CurseBlind}} image {{CurseBlindSmall}} image
{{CurseGiant}} image {{CurseGiantSmall}} image

Major bosses

Markup Icon Markup Icon
{{MomBoss}} image {{MomBossSmall}} image
{{MomsHeart}} image {{MomsHeartSmall}} image
{{Satan}} image {{SatanSmall}} image
{{Isaac}} image {{IsaacSmall}} image
{{Delirium}} image {{DeliriumSmall}} image
{{Hush}} image {{HushSmall}} image
{{Mother}} image {{MotherSmall}} image
{{BlueBaby}} image {{BlueBabySmall}} image
{{TheLamb}} image {{TheLambSmall}} image
{{MegaSatan}} image {{MegaSatanSmall}} image

Miscellaneous icons

Markup Icon Markup Icon
{{Timer}} image {{TimerSmall}} image
{{HardMode}} image {{HardModeSmall}} image
{{GreedMode}} image {{GreedModeSmall}} image
{{GreedierMode}} image {{GreedierModeSmall}} image
{{AchievementLocked}} image {{AchievementLockedSmall}} image
{{VictoryLap}} image {{VictoryLapSmall}} image
{{DailyRun}} image {{DailyRunSmall}} image
{{DonationMachineJam}} image {{Trophy}} image

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}} image
{{Guppy}} image
{{LordoftheFlies}} image
{{FunGuy}} image
{{Seraphim}} image
{{Bob}} image
{{Spun}} image
{{Mom}} image
{{Conjoined}} image
{{Leviathan}} image
{{OhCrap}} image
{{Bookworm}} image
{{SpiderBaby}} image
{{SuperBum}} image
{{Stompy}} image
{{Adult}} image

Room shape Icons

Markup Icon
{{Room}} icon_7_0
{{RoomSmallHorizontal}} icon_7_1
{{RoomSmallVertical}} icon_7_2
{{RoomLongVertical}} icon_7_3
{{RoomLongHorizontal}} icon_7_4
{{RoomLongThinVertical}} icon_7_5
{{RoomLongThinHorizontal}} icon_7_6
{{RoomXL}} icon_7_7
{{RoomL}} icon_7_8
{{RoomLTopLeft}} icon_7_9
{{RoomLBottomLeft}} icon_7_10
{{RoomLBottomRight}} icon_7_11

Player Icons

Player Icons are defined by {{Player[PlayerType]}}

Markup Icon Markup Icon Markup Icon
{{Player0}} row-1-column-1 {{Player21}} row-5-column-1
{{Player1}} row-1-column-2 {{Player22}} row-5-column-2
{{Player2}} row-1-column-3 {{Player23}} row-5-column-3
{{Player3}} row-1-column-4 {{Player12}} {{Player24}} row-5-column-4
{{Player4}} row-1-column-5 {{Player25}} row-5-column-5
{{Player5}} row-1-column-6 {{Player26}} row-5-column-6
{{Player6}} row-2-column-1 {{Player27}} row-6-column-1
{{Player7}} row-2-column-2 {{Player28}} row-6-column-2
{{Player8}} {{Player11}} row-2-column-3 {{Player29}} row-6-column-3 {{Player38}} row-4-column-3
{{Player9}} row-2-column-4 {{Player30}} row-6-column-4
{{Player10}} row-2-column-5 {{Player31}} row-6-column-5
{{Player13}} row-2-column-6 {{Player32}} row-6-column-6
{{Player14}} row-3-column-1 {{Player33}} row-7-column-1
{{Player15}} row-3-column-2 {{Player34}} row-7-column-2
{{Player16}} row-3-column-3 {{Player17}} row-4-column-5 {{Player35}} {{Player40}} row-7-column-3
{{Player18}} row-3-column-4 {{Player36}} row-7-column-4
{{Player19}} row-3-column-5 {{Player37}} row-7-column-5
{{Player20}} row-3-column-6 {{Player39}} row-7-column-6

Itempools

Markup Icon
{{ItemPoolTreasure}} row-1-column-1
{{ItemPoolShop}} row-1-column-2
{{ItemPoolBoss}} row-1-column-3
{{ItemPoolDevil}} row-1-column-4
{{ItemPoolAngel}} row-1-column-5
{{ItemPoolSecret}} row-1-column-6
{{ItemPoolLibrary}} row-1-column-7
{{ItemPoolShellGame}} row-1-column-8
{{ItemPoolGoldenChest}} row-2-column-1
{{ItemPoolRedChest}}
{{ItemPoolBeggar}} row-2-column-3
{{ItemPoolDemonBeggar}} row-2-column-4
{{ItemPoolCurse}} row-2-column-5
{{ItemPoolKeyMaster}} row-2-column-6
{{ItemPoolBombBum}} row-2-column-7
{{ItemPoolMomsChest}} row-2-column-8
{{ItemPoolGreedTreasure}} row-3-column-1
{{ItemPoolGreedShop}} row-3-column-2
{{ItemPoolGreedBoss}} row-3-column-3
{{ItemPoolGreedDevil}} row-3-column-4
{{ItemPoolGreedAngel}} row-3-column-5
{{ItemPoolGreedCurse}} row-3-column-6
{{ItemPoolGreedSecret}} row-3-column-7
{{ItemPoolCraneGame}} row-3-column-8
{{ItemPoolUltraSecret}} row-4-column-1
{{ItemPoolBatteryBum}} row-4-column-2
{{ItemPoolPlanetarium}} row-4-column-3
{{ItemPoolOldChest}} row-4-column-4
{{ItemPoolBabyShop}} row-4-column-5
{{ItemPoolWoodenChest}} row-4-column-6
{{ItemPoolRottenBeggar}} row-4-column-7