Setup Augmentations
Create an augmentations.json file that configures leaderboards and other meta-game features using the deeds defined in the previous step.
Steps
- Create
augmentations.jsonin the project root:{"_v": 1, "augmentations": {"leaderboards": [{"displayName": "Fastest Time", "stableID": "game-GAMESLUG:time", "order": "Lower=better", "deedID": "time", "formatString": "[time]"}, {"displayName": "High Score", "stableID": "game-GAMESLUG:points", "order": "Higher=better", "deedID": "points", "formatString": "%@"}]}} - Replace
GAMESLUGwith the actual game slug (the directory name, lowercased). - Add leaderboards for each meaningful deed. The
stableIDformat MUST begame-[gameslug]:[deed-id]. - Choose appropriate
formatStringvalues:
- "[time]" - Converts seconds to MM:SS format - "%@" - Shows the number with locale formatting - "%@ moves" - Appends a unit - "%@%" - Shows as percentage
- Set
orderappropriately:
- "Lower=better" for time, moves, errors - "Higher=better" for score, accuracy, streaks
Success Criteria
augmentations.jsonexists and is valid JSON- At least 2 leaderboards are configured
- All
stableIDvalues follow thegame-slug:deed-idformat formatStringvalues are appropriate for each metric