create-spud

The quickest way to set up and scaffold a spud game.

Quick start

bun create spud

What gets created

• A new folder named after your game
• A ready-to-run minimal spud game project

Automatically set up for you

• A working Vite + TypeScript project with hot module replacement (no config needed)
• Canvas setup with DPI-aware scaling
• Fixed‑timestep update loop + variable-rate render loop ready to edit
• Static asset import handling through Vite and image optimization
• index.html and demo.html entry points with scripts ready to run
  • (Demo mode is a non-interactive gameplay example, providing your potential players a preview into your actual game. Spud favors realistic self-playing demos over pre-recorded trailers.)
• Gamepad integration with the spud API (npm)
• Optional:
  • Audio examples (low-latency Web Audio API sfx and streaming background music) with autoplay best practices for web games.
  • Pixel‑art mode (example sprite sheet, image smoothing disabled)

Requirements

• Bun (runtime + package manager)

1. Install Bun (docs):

curl -fsSL https://bun.sh/install | bash

2. Then restart your terminal so bun is on your $PATH.

Notes

• This CLI is Bun-only. If you try to run it with Node (npx create spud, for example), that won't work.