setup-deploy
Setup Deploy
Configure the project to deploy game builds to Puzzmo using the CLI.
Steps
-
Install the Puzzmo CLI as a dev dependency:
npm install --save-dev @puzzmo/cli -
Add deploy scripts to
package.json:{ "scripts": { "deploy": "npm run build && puzzmo upload GAMESLUG dist", "deploy:only": "puzzmo upload GAMESLUG dist" } } -
Replace
GAMESLUGwith the actual game slug. -
Create a
.gitignoreif it doesn't exist, including:node_modules/ dist/ .env -
Initialize a git repository if not already initialized:
git init -
Add a
README.mdwith basic instructions:# Game Name ## Development npm run dev ## Build npm run build ## Deploy puzzmo login <your-token> npm run deploy
Success Criteria
npm run buildcompletes without errorspuzzmo uploadcommand is configured in package.json.gitignoreexcludes node_modules and dist- Game slug matches across all config files
More from puzzmo-com/oss
puzzmo-theme
Convert hardcoded colors to use Puzzmo theme tokens for light/dark mode support
10create-app-bundle
Create app metadata, thumbnail, and offline configuration for the Puzzmo platform
10add-deeds
Generate interesting gameplay statistics (deeds) sent on game completion
9convert-to-vite
Convert a standalone HTML game into a Vite project with proper module structure
9setup-augmentations
Create augmentations.json with leaderboard configuration using deeds
9game-completion
Wire up game completion signaling to the Puzzmo host
8