Skip to content

Keywords

Alchyr edited this page Dec 16, 2023 · 8 revisions

Keywords should always be capitalized in card/relic/power text. Base game keywords can be used as-is.

Keywords from your mod must be prefixed with your mod's id. Keywords in card text are automatically detected. For relics, keywords must be prefixed with #y to work properly. For any other text, there is no keyword detection. Power descriptions are only seen as tooltips when hovering over the player, and if tooltips could generate other tooltips that could cause a lot of problems. For these cases, just write the text you want to see.


Example of using the keyword "Hello" and the keyword Strength.

In Keywords.json:

  {
    "PROPER_NAME": "Hello",
    "NAMES": [
      "hello"
    ],
    "DESCRIPTION": "This is a description of what the keyword does."
  },

In card text: "Gain 1 Strength. NL Next turn, gain 1 ${modID}:Hello."

In a relic: "At the start of each combat, gain #b1 #yStrength and #b1 #y${modID}:Hello." (Numbers are also colored blue in relics and powers.)

In a power: "At the start of each turn, gain #b1 #yStrength and #b1 #yHello."

Since the keywords in a power description aren't detected, you just write what you want the player to see.

Clone this wiki locally