Skip to content

blit386/create-blit386

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

create-blit386

create-blit386 on npm @blit386/kit on npm License: ISC

One command, and you have a little pixel game running in your browser. create-blit386 writes a ready-to-go BLIT386 project – a starter game, a working build, and docs – so you can spend the first five minutes playing instead of wiring things up.

Start a game in seconds

npm create blit386@latest my-game
cd my-game
npm run dev

A web address appears. Open it. That is your game, already running. Open src/game.js and start changing things – every line has a comment that explains itself.

It works with npm, pnpm, yarn, or bun – the scaffolder quietly uses whichever one you ran it with.

What you get

The wizard asks two quick questions (language, and whether you want an AI assistant set up), then writes:

  • A Catcher starter game – a tiny, complete, heavily commented game you can read top to bottom.
  • A Vite project that builds and runs with one command.
  • JavaScript by default, or TypeScript if you ask for it (--ts).
  • Local docs and an AGENTS.md, so your editor's AI actually knows how the engine works.
  • The blit CLI: blit run, blit doctor, blit upgrade, and blit agents for keeping assistant files current.
  • Optional Claude or Cursor config, generated from the kit's canonical content – pick one in the wizard, or add it later with npx blit agents add.

Never used Node.js before?

The command above needs Node.js – a free program that runs JavaScript on your computer. These instructions live here on purpose: a brand-new project cannot teach you to install the thing it needs to exist. One-time setup:

  1. Go to nodejs.org and download the button marked LTS ("the stable one").
  2. Install it like any other app: keep clicking Next or Continue.
  3. Open a terminal (your editor has one built in – in Zed or VS Code, look for "Terminal" in the menu). If the editor was already open, quit and reopen it first so it notices Node.
  4. Now run the three Start commands above, one line at a time.

Send this to a friend

Starting someone else off? Copy and paste this:

Want to make a little pixel game? First install Node.js: go to nodejs.org, download the LTS button, and install it like any app. Then open the terminal inside your editor and type these three lines, pressing Enter after each: npm create blit386@latest my-game, then cd my-game, then npm run dev. A web address appears – open it in your browser and you are playing your own game. Open src/game.js to change it; every line has a comment that explains itself.

What is in this repo

A pnpm monorepo with two published packages:

  • create-blit386 (packages/create-blit386) – the npm create blit386 scaffolder: the wizard and the project templates.
  • @blit386/kit (packages/kit) – the canonical AI docs (AGENTS.md + local docs/) and the project-local blit CLI (run, doctor, upgrade, agents sync, agents add).

Working on it

pnpm install
pnpm run build        # build both packages with tsup
pnpm run typecheck    # tsc --noEmit per package
pnpm run test         # scaffolder smoke test (needs a build first)
pnpm run preflight    # format:check + lint + typecheck + spellcheck + knip + docs:links + build + test

CI runs the same checks on every push and pull request to main. Publishing to npm is a deliberate, manual step (it is not automated here). The full roadmap lives in CREATE_BLIT386_DESIGN.md.

Related

Made by

Built by Václav Vančura (@vancura) – one person, so far.

License

ISC.