File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11---
22name : setup-augmentations
3- description : Create augmentations .json with leaderboard configuration using deeds
3+ description : Add integrations to puzzmo .json with leaderboard configuration using deeds
44---
55
66# Setup Augmentations
77
8- Create an ` augmentations .json` file that configures leaderboards and other meta-game features using the deeds defined in the previous step.
8+ Add an ` integrations ` field to ` puzzmo .json` that configures leaderboards and other meta-game features using the deeds defined in the previous step.
99
1010## Steps
1111
12- 1 . Create ` augmentations.json ` in the project root :
12+ 1 . Add the ` integrations ` field to the existing ` puzzmo.json ` :
1313
1414 ``` json
1515 {
16- "_v" : 1 ,
17- "augmentations" : {
16+ "$schema" : " https://dev.puzzmo.com/schema/puzzmo-file-schema.json" ,
17+ "game" : {
18+ "displayName" : " Your Game" ,
19+ "slug" : " GAMESLUG" ,
20+ "teamID" : " TEAMID"
21+ },
22+ "integrations" : {
1823 "leaderboards" : [
1924 {
2025 "displayName" : " Fastest Time" ,
@@ -31,6 +36,9 @@ Create an `augmentations.json` file that configures leaderboards and other meta-
3136 "formatString" : " %@"
3237 }
3338 ]
39+ },
40+ "output" : {
41+ "dir" : " dist"
3442 }
3543 }
3644 ```
@@ -51,7 +59,7 @@ Create an `augmentations.json` file that configures leaderboards and other meta-
5159
5260## Success Criteria
5361
54- - ` augmentations .json` exists and is valid JSON
62+ - ` puzzmo .json` has an ` integrations ` field with valid configuration
5563- At least 2 leaderboards are configured
5664- All ` stableID ` values follow the ` game-slug:deed-id ` format
5765- ` formatString ` values are appropriate for each metric
Original file line number Diff line number Diff line change @@ -20,13 +20,13 @@ Configure the project to deploy game builds to Puzzmo using the CLI.
2020 ``` json
2121 {
2222 "scripts" : {
23- "deploy" : " puzzmo upload GAMESLUG dist " ,
24- "deploy:only" : " puzzmo upload GAMESLUG dist "
23+ "deploy" : " npm run build && puzzmo upload " ,
24+ "deploy:only" : " puzzmo upload"
2525 }
2626 }
2727 ```
2828
29- 3 . Replace ` GAMESLUG ` with the actual game slug.
29+ 3 . The CLI discovers the game slug from ` puzzmo.json ` automatically .
3030
31314 . Create a ` .gitignore ` if it doesn't exist, including:
3232
You can’t perform that action at this time.
0 commit comments