custom token

Create custom tokens for Content Patcher to expand achievable modification capabilities

Custom Tokens

🌟 **Custom Token** is a mod that provides additional tokens for Content Patcher, greatly expanding the achievable modification functions!

---

🎯 List of registered tokens

📍 Location Token

• **MineLevel** - The mine level the player is currently on
• **VolcanoFloor** - The volcano floor the player is currently on
• **DeepestMineLevel** - The deepest mine level the player has reached (including Skull Cave)
• **DeepestVolcanoFloor** - The deepest volcano level the player has reached
• **DeepestNormalMineLevel** - The deepest normal mine level reached by the player
• **DeepestSkullCavernMineLevel** - The deepest skeleton cave level reached by the player

💍 Marriage Token

• **AnniversaryDay** and **AnniversarySeason** - date and season of wedding anniversary
• **YearsMarried** - total number of years married
• **DaysMarried** - Total number of days married

📋 Task Token

• **QuestIDsCompleted** - List of quest IDs that the player has completed
• **QuestsCompleted** - Total number of completed quests
• **SOIDsCompleted** - List of special orders completed by the player (including Mr. Qi's challenges)
• **SOCompleted** - Total number of special orders completed

💀 Death and Fatigue Token

• **DeathCount** - Total number of player deaths
• **DeathCountMarried** - number of deaths after marriage
• **DeathCountPK** - A more accurate death count used in PlayerKilled events
• **DeathCountMarriedPK** - Accurate death count after marriage
• **PassOutCount** - Number of times the player passed out

🔧 Premium Token

• **Child** - a token containing information about the player's children, requires input parameters to work

---

🚀 Instructions for use

**System Requirements:**

• SMAPI 4.0 or higher must be installed
• List Custom Tokens as a dependency in content packs
• The token used must be prefixed with the module's unique ID, for example: `TheMightyAmondee.CustomTokens/MineLevel`
• Many tokens require the update frequency to be set to `OnLocationChange`, `OnTimeChange`, or both to work properly

---

👶 Detailed explanation of child tokens

Child tokens require 3 input parameters (case insensitive):

• **player** - Player type: `host` (main player) or `local` (current player, possibly farm helper)
• **childindex** - child index (starting from 0): 0 represents the oldest child, 1 represents the second oldest child, and so on
• **value** - the value to get:
• `birthdayday` - date of birth
• `birthdayseason` – birth season
• `daysold` - current age (number of days)
• `darkskinned` - whether to use dark skinned sprites
• `hat` - the name of the hat currently worn

**Full token example:**

```

TheMightyAmondee.CustomTokens/Child:player=host|childindex=0|birthdayday

```

This token returns the birth date of the primary player's first child

---

⚙️ Configuration options

• **AllowDebugging** - Enable debugging, enter "tracker" in the SMAPI console to view the token value
• **ResetDeathCountMarriedWhenDivorced** - Whether to reset the married death count when divorced (default is true)

---

📖 **For more information please see**: GitHub README

🔧 **Source code**: GitHub repository