Game Deployment

GitHub Pages Deployment

Prerequisites

• GitHub CLI installed (

  gh

  )
• Git repository initialized and pushed to GitHub

Quick Deploy

npm run build && npx gh-pages -d dist

Full Setup

1. Build the game:

npm run build

1. Ensure

   vite.config.js

   has the correct base path if deploying to a subdirectory:

export default defineConfig({
  base: '/<repo-name>/',
  // ... rest of config
});

1. Deploy with GitHub CLI:

gh repo create <game-name> --public --source=. --push
npm install -D gh-pages
npx gh-pages -d dist

1. Enable GitHub Pages in repo settings (should auto-detect the

   gh-pages

   branch).

https://<username>.github.io/<repo-name>/

Automated Deploys

package.json

{
  "scripts": {
    "deploy": "npm run build && npx gh-pages -d dist"
  }
}

Play.fun Registration

/game-creator:playdotfun

gameUrl

await client.games.register({
  name: 'Your Game Name',
  gameUrl: 'https://<username>.github.io/<repo-name>/',
  maxScorePerSession: 500,
  maxSessionsPerDay: 20,
  maxCumulativePointsPerDay: 5000
});

Other Hosting Options

• Vercel:

  npx vercel --prod

  (auto-detects Vite)
• Netlify: Connect repo, set build command to

  npm run build

  , publish dir to

  dist

• Railway: Use the Railway skill for deployment
• itch.io: Upload the

  dist/

  folder as an HTML5 game

Pre-Deploy Checklist

• npm run build

  succeeds with no errors
• Test the production build with

  npm run preview

• Remove any

  console.log

  debug statements
• Verify all assets are included in the build
• Check mobile/responsive behavior if applicable
• Set appropriate

  <title>

  and meta tags in

  index.html