Player_Data.json

Player_Data.json

Stores each player's progress, claimed rewards and shiny record. Located at config/DexRewards/players/<player_uuid>.json, one file per player.

Caution

These files are written by the mod. You normally don't need to edit them: use /dex reset and /dex update instead. If you do edit one, make sure that player is offline, because the mod loads the file when they join and overwrites it when their progress changes or they leave.

A player's file is created the first time they join, and saved whenever their progress or rewards change and when they leave.

Example

{
  "uuid": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
  "username": "Steve",
  "pokedex_progress": {
    "national": {
      "progress_count": 52,
      "claimed_rewards": ["newcomer", "rookie"],
      "claimable_rewards": ["trainer"]
    },
    "shiny_kanto": {
      "progress_count": 1,
      "claimed_rewards": [],
      "claimable_rewards": ["first_shiny"]
    }
  },
  "caught_shinies": {
    "cobblemon:magikarp": ["normal"],
    "cobblemon:rotom": ["normal", "wash"]
  }
}

Top Level

Field	Type	Description
uuid	string	The player's UUID.
username	string	The player's name when the file was created. For your reference only.
pokedex_progress	object	A map of dex type ID → that dex type's progress. See below.
caught_shinies	object	A map of species ID → the forms the player has obtained as a shiny, in lowercase. Used by dex types with require_caught and require_shiny. See How-It-Works.

Dex Type Progress

Field	Type	Description
progress_count	integer	How many of the dex type's Pokémon (or forms) the player has completed. Recalculated automatically, so editing it has no lasting effect.
claimed_rewards	list	IDs of the reward groups the player has claimed. Remove an ID to let them claim it again, or use /dex reset to clear the whole dex type.
claimable_rewards	list	IDs of the reward groups the player has unlocked but not claimed. Recalculated automatically.

Progress for a dex type is added the first time the player's progress updates after that dex type is created.

Note

If a player's file can't be read, an error is logged and that player's progress isn't tracked or saved until the file is fixed. The file itself is left untouched.

See Also

• How-It-Works: when progress updates and how rewards unlock.
• Commands: /dex reset and /dex update.