Stats As Tokens

by Vertigon

NexusMods
GitHub

This mod allows Content Patcher pack creators to access all stats tracked by the game through custom CP tokens, allowing for patches to trigger on various player milestones including number of seeds sown, truffles found, palm trees cut down, trash cans checked and many more! See below for a complete list.

Usage

Download this mod, place it in your Mods folder, and list it as a dependency in your manifest.json in order to access its custom tokens.

Dependencies

• SMAPI v3.12.0 or higher is a required dependency.
• Content Patcher v1.23.0 or higher is a required dependency.

Custom Tokens Provided

Vertigon.StatsAsTokens/Stats

This token takes exactly two named arguments (both must be provided in order for it to work):

• player: Must be one of the following:
  • host: The player hosting the lobby, or
  • local: The player on the local splitscreen or computer, if not the host
• stat: The stat to track. See below for a complete list.

The arguments are case-insensitive and space-insensitive.

For example: {{Vertigon.StatsAsTokens/Stats:player=host|stat=diamondsFound}} will be parsed as the number of diamonds found by the host player.

Here is a complete list of stats currently usable as arguments:

• seedsSown
• itemsShipped
• itemsCooked
• itemsCrafted
• chickenEggsLayed
• duckEggsLayed
• cowMilkProduced
• goatMilkProduced
• rabbitWoolProduced
• sheepWoolProduced
• cheeseMade
• goatCheeseMade
• trufflesFound
• stoneGathered - Note: This is how many pieces of stone you have picked up, from any source.
• rocksCrushed - This is how many rocks you have broken.
• dirtHoed
• giftsGiven
• timesUnconscious
• averageBedtime
• timesFished
• fishCaught
• bouldersCracked - And this is how many boulders (big 2x2 clumps) you have broken.
• stumpsChopped
• stepsTaken
• monstersKilled
• diamondsFound
• prismaticShardsFound
• otherPreciousGemsFound
• caveCarrotsFound
• copperFound
• ironFound
• coalFound
• coinsFound
• goldFound
• iridiumFound
• barsSmelted
• beveragesMade
• preservesMade
• piecesOfTrashRecycled
• mysticStonesCrushed
• daysPlayed
• weedsEliminated
• sticksChopped
• notesFound
• questsCompleted
• starLevelCropsShipped
• cropsShipped
• itemsForaged
• slimesKilled
• geodesCracked
• goodFriends
• totalMoneyGifted
• individualMoneyEarned
• timesEnchanted
• beachFarmSpawns
• hardModeMonstersKilled
• childrenTurnedToDoves
• boatRidesToIsland
• trashCansChecked
  * Note that certain stats are broken (weren't properly being tracked by the game) and will not be accurate on existing saves. On new saves, they should work as intended since I have introduced a fix for these.

And some custom stats that I have added support for (mostly stuff that seems to have been left out of the game for whatever reason):

• ostrichEggsLayed
• dinosaurEggsLayed
• duckFeathersDropped
• rabbitsFeetDropped
• mayonnaiseMade
• duckMayonnaiseMade
• voidMayonnaiseMade
• dinosaurMayonnaiseMade

Vertigon.StatsAsTokens/MonstersKilled

This token takes exactly two named arguments (both must be provided in order for it to work):

• player: Must be one of the following:
  • host: The player hosting the lobby, or
  • local: The player on the local splitscreen or computer, if not the host
• monster: The monster to check kills for. See below for a complete list.

The arguments are case-insensitive and space-insensitive.

For example: {{Vertigon.StatsAsTokens/MonstersKilled:player=local|monster=Green Slime}} will be parsed as the number of slimes (all slimes except Big Slimes and Tiger Slimes are considered Green Slime for this purpose) killed by the local player.

Here is a complete list of monsters currently usable as arguments:

• Green Slime
• Dust Spirit
• Bat
• Frost Bat
• Lava Bat
• Iridium Bat
• Stone Golem
• Wilderness Golem
• Grub
• Fly
• Frost Jelly
• Sludge
• Shadow Guy
• Ghost
• Carbon Ghost
• Duggy
• Rock Crab
• Lava Crab
• Iridium Crab
• Fireball
• Squid Kid
• Skeleton Warrior
• Crow*
• Frog*
• Cat*
• Shadow Brute
• Shadow Shaman
• Skeleton
• Skeleton Mage
• Metal Head
• Spiker
• Bug
• Mummy
• Big Slime
• Serpent
• Pepper Rex
• Tiger Slime
• Lava Lurk
• Hot Head
• Magma Sprite
• Magma Duggy
• Magma Sparker
• False Magma Cap
• Dwarvish Sentry
• Putrid Ghost
• Shadow Sniper
• Spider
• Royal Serpent
• Blue Squid
  * not actually monsters, but stored in Data/Monsters. Probably will never be anything other than 0.

Theoretically this token supports custom monster types as well, so long as they provide the game with a proper Name variable when instantiated.

Vertigon.StatsAsTokens/FoodEaten

This token takes exactly two named arguments (both must be provided in order for it to work):

• player: Must be one of the following:
  • host: The player hosting the lobby, or
  • local: The player on the local splitscreen or computer, if not the host
• food: The edible item to check for amount eaten. You can provide either the food name, or the item ID. You can also provide the keyword any to get the total number of food items eaten by the selected player.

The arguments are case-insensitive and space-insensitive.

For example: {{Vertigon.StatsAsTokens/FoodEaten:player=local|food=434}} will be parsed as the number of Stardrops (item ID 434) eaten by the local player.
{{Vertigon.StatsAsTokens/FoodEaten:player=host|food=leek}} will be parsed as the number of Leeks eaten by the host.
{{Vertigon.StatsAsTokens/FoodEaten:player=local|food=any}} will be parsed as the total number of food items the local player has eaten.

Note that this should support JA/DGA items. However, without a hard DGA dependency I can't initialize DGA items in the internal list (JA items should be okay). What does this mean?

Well, if a player hasn't yet eaten a DGA item, if you try to get the number eaten it will be returned as "" instead of 0. This will break the enclosing Query expression. In practice, this should have the same effect as if the conditions were false, but it may have unintended effects. If DGA's API gets expanded I will revisit this issue and try to resolve it in a satisfactory manner.

Vertigon.StatsAsTokens/TreesFelled

This token takes exactly two named arguments (both must be provided in order for it to work):

• player: Must be one of the following:
  • host: The player hosting the lobby, or
  • local: The player on the local splitscreen or computer, if not the host
• type: The type of tree to check. You can provide either the tree name, or the internal tree type number. See below for a complete list. You can also provide the keyword any to get the total number of trees felled by the selected player.

The arguments are case-insensitive and space-insensitive.

For example: {{Vertigon.StatsAsTokens/TreesFelled:player=local|type=1}} will be parsed as the number of trees of type 1 (oak trees) felled by the local player.
{{Vertigon.StatsAsTokens/TreesFelled:player=host|type=maple}} will be parsed as the number of maple trees (type 2) felled by the host.
{{Vertigon.StatsAsTokens/TreesFelled:player=local|type=any}} will be parsed as the total number of trees felled by the local player.

Here is a complete list of tree types/names currently usable as arguments:

• oak (1)
• maple (2)
• pine (3)
• palm (6) *
• mushroom (7)
• mahogany (8)
• palm2 (9) * * For simplicity's sake, palm and palm2 are condensed into one stored value under the hood. Inputting either as the type will give you the total number of palms felled.

Vertigon.StatsAsTokens/AnimalsOwned

This is a set of three tokens, each of which takes exactly one named argument. The tokens are as follows:

• AnimalNames: Returns a list of the names of all farm animals on the current farm (including horses).
• AnimalAges: Returns a list of the ages of all farm animals on the current farm (including horses).
• AnimalTypes: Returns a list of the types of all farm animals on the current farm (including horses).

Each token takes a type argument: this is the type of animal by which the results are filtered. The argument is case-insensitive and space-insensitive. Valid types usable as arguments:

• White Chicken
• Brown Chicken
• Blue Chicken
• Void Chicken
• Golden Chicken
• Duck
• Rabbit
• Dinosaur
• White Cow
• Brown Cow
• Goat
• Pig
• Hog
• Sheep
• Ostrich
• Horse
• Barn *
• Coop *
• Any * * These values are special - see Notes below.

Notes

The any value will return a list of all animals owned on the farm. This includes horses and all forms of livestock (it does not include fish ponds currently).

The barn and coop values will return a list of all animals that live in the specified building type.

The type argument utilizes fuzzy string matching - for example, type=Chicken will return a list of every type of Chicken - White, Brown, Void, etc.

Utilizing Tokens Effectively

While the tokens provided allow for a wide range of new options, for maximum effect you will need to pair them with several core features provided by Content Patcher.

Firstly, I highly recommend familiarizing yourself with the Content Patcher documentation. The tokens guide in particular will come in handy as the global tokens provided are extremely powerful, especially in conjunction with those provided by this mod.

As the majority of tokens provided by Stats As Tokens are numerical in nature, number manipulation tokens will allow you a greater range of expression. For example, tokens which return multiple values, such as the AnimalsOwned tokens, are best used with the valueAt argument, or the Count and Random tokens. Here is an example which selects the name of one animal from the list of animals owned on the current farm:

"AnimalName": {{Random: {{Vertigon.StatsAsTokens/AnimalNames:type=any}} }}

This can be further utilized with pinned keys to, for example, get an animal's name and age randomly:

"AnimalName": {{Random: {{Vertigon.StatsAsTokens/AnimalNames:type=any}} |key=1}}
"AnimalAge": {{Random: {{Vertigon.StatsAsTokens/AnimalAges:type=any}} |key=1}}

This works because the AnimalsOwned tokens are guaranteed to return the list in a consistent order, meaning that using the same key will result in the same index being selected.

Query Expressions allow you to evaluate mathematical and logical expressions within a When condition or inside a field or token. Here is an example which checks to see if the player has consumed 5 or more Joja Colas in order to determine whether or not to apply a patch:

"When": {
    "Query: {{Vertigon.StatsAsTokens/FoodEaten:player=host|food=joja}} >= 5": true
}

Note that the food argument attempts to match the item name using 'fuzzy string matching', as demonstrated here - it will match joja to Joja Cola automatically. However, to avoid unforeseen issues (i.e. what happens when somebody adds a Joja Apple?), it is best to fully write out the item name.

Here is a slightly trickier condition which combines number manipulation with a Query expression, to determine if the player currently owns an animal of the specified type:

"When": {
	"Query": {{Count: {{Vertigon.StatsAsTokens/AnimalNames:type=Blue Chicken}} }} >= 1: true
}

Query expressions, while powerful, are also unpredictable - they are not fully validated ahead of time, and may just fail without warning if improperly formatted. Test your expressions thoroughly with the patch parse command.

Upcoming Features

• Rework argument handling to be more generic
  • Pass in arguments in any order
  • Take PlayerId as parameter (see Content Patcher 1.24.0)
  • Support JA/DGA items
• Track more custom stats! Message me on Discord (Vertigon#1851) if you have ideas for custom stats to track
  • Number of items gifted by type - game already tracks total number
  • Number of items cooked/crafted - filterable by item name
  • Number of trees planted - filterable by type
  • Number of buildings built - filterable by type
  • Items donated to the museum
• Track spouse anniversaries/days married
• Track children birthdays/days alive
• Previous day's weather

If you have any issues:

• Read the documentation carefully. I have tried to be as thorough as possible.
• Make sure SMAPI and Content Patcher are up-to-date.
• You can reach me on the Stardew Valley discord (Vertigon#1851) or on the Nexus mod page.
• Please provide a SMAPI log, as well as your manifest.json and content.json, so that I can assist you better.