Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/excaliburjs/create-excalibur. A repo bootstrapping tool to get you started making your first games!
Something went wrong. Try again.
12 kB · 386 lines
TypeScript
at main
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386import { createNewGame } from "./flows/create-new-game.ts";import { inspectGame } from "./flows/inspect-game.ts";import { createSample } from "./flows/create-sample.ts";import { searchDocs } from "./flows/docs.ts";import { generateFlow } from "./flows/generate.ts";import { mcpFlow } from "./flows/mcp.ts";import { doctorFlow } from "./flows/doctor.ts";import { upgradeFlow } from "./flows/upgrade.ts";
/** A CLI flow: receives the remaining argv after its command name. */export type Flow = (argv?: string[]) => Promise<void> | void;/** Registered flow keys, aliases included — derived from FLOWS below. */export type FlowName = keyof typeof FLOWS;
export const FLOW_CHOICES: Array<{ name: string; value: FlowName }> = [ { name: "Create a game", value: "create", // description: "[ Start a new project ]", }, { name: "Create a sample project", value: "sample", // description: "[ Start a new project ]", }, { name: "Inspect a game", value: "inspect", // description: "[ Check games already build with Excalibur ]", }, { name: "Search the docs", value: "docs", // description: "[ Search excaliburjs.com docs & API from the terminal ]", }, { name: "Generate code (actor, scene, resource…)", value: "generate", // description: "[ Scaffold into an existing Excalibur project ]", }, { name: "Upgrade — migrate your game to a newer Excalibur", value: "upgrade", // description: "[ Codemod-style version migrations ]", }, { name: "Doctor — check your game for common mistakes", value: "doctor", // description: "[ Type-aware diagnostics for an existing project ]", },];export const FLOWS = { create: createNewGame, sample: createSample, inspect: inspectGame, docs: searchDocs, generate: generateFlow, g: generateFlow, mcp: mcpFlow, doctor: doctorFlow, upgrade: upgradeFlow, up: upgradeFlow,} satisfies Record<string, Flow>;/** * Flow keys (including aliases) that must skip the intro banner — they have * a clean-stdout contract (`--json`, MCP's stdout-is-protocol-only). Listed * as FLOWS keys, not flow names, so an alias (e.g. "up") doesn't slip * through the same carve-out its canonical name already has. */export const QUIET_FLOWS: ReadonlySet<FlowName> = new Set<FlowName>(["docs", "mcp", "doctor", "upgrade", "up"]);export interface TemplateDefinition { name: string; value: string; description: string; repo: string; startCommand: string;}
export const TEMPLATES: TemplateDefinition[] = [ { name: "Typescript with Vite", value: "typescript_vite", description: "", repo: "https://github.com/excaliburjs/template-ts-vite.git", startCommand: "npm run dev", }, { name: "Typescript with Parcel", value: "typescript_parcel", description: "", repo: "https://github.com/excaliburjs/template-ts-parcel-v2.git", startCommand: "npm run start", }, { name: "Typescript with Rollup", value: "typescript_rollup", description: "", repo: "https://github.com/excaliburjs/template-ts-rollup.git", startCommand: "npm run start", }, { name: "Vanilla JavaScript 😎", value: "javascript_vanilla", description: "", repo: "https://github.com/excaliburjs/template-vanilla-js.git", startCommand: "npm run start", }, { name: "Typescript with Webpack", value: "typescript_webpack", description: "", repo: "https://github.com/excaliburjs/template-ts-webpack.git", startCommand: "npm run dev", }, { name: "TypeScript with Tauri 2.0 (Desktop + Mobile)", value: "javascript_tauri_2", description: "", repo: "https://github.com/excaliburjs/template-tauri-v2", startCommand: "npm run start", }, { name: "TypeScript with Tauri 1.0 (Desktop)", value: "javascript_tauri_1", description: "", repo: "https://github.com/excaliburjs/template-tauri", startCommand: "npm run start", }, { name: "TypeScript with Capacitor.js (Mobile)", value: "javascript_capacitorjs", description: "", repo: "https://github.com/excaliburjs/template-capacitorjs", startCommand: "npm run start", }, { name: "TypeScript with Electron", value: "javascript_electron", description: "", repo: "https://github.com/excaliburjs/template-electron.git", startCommand: "npm run start", }, { name: "Typescript with Browserify", value: "javascript_browserify", description: "", repo: "https://github.com/excaliburjs/template-ts-browserify.git", startCommand: "npm run all", }];export interface ShowcaseDefinition { title: string; value: string; description: string; url: string; source: string; /** display label minted by the inspect flow */ name?: string;}
export const SHOWCASES: ShowcaseDefinition[] = [ { title: "Excali-Farm", value: "Excali-Farm",
description: "A little farming game created with the Excalibur Tiled plugin. Come and enjoy the supremely cozy vibes on this lovely farm.", url: "https://excali-farm.netlify.app/", source: "https://github.com/mahbarahona/tiles", }, { title: "Retro Ski", value: "Retro Ski",
description: "Put your skis and let's race some randomly generated alpine ski tracks with your friends.", url: "https://une-entreprise.ch/retroski/", source: "https://github.com/mathieuher/RetroSki", }, { title: "Night Bike", value: "Night Bike",
description: "Ride your motorcycle through the city at night! Jump over as many vehicles as you can!", url: "https://nightbike.mattjennin.gs/", source: "https://github.com/mattjennings/nightbike", }, { title: "Super Metronome Hero", value: "Super Metronome Hero",
description: "Super Metronome Hero is a rhythm game. Rather than trying to make a game I wanted to play out of this rather popular genre I decided to send it up with this nonsense joke game.", url: "https://super-metronome-hero.vidja.games/", source: "https://github.com/dcgw/super-metronome-hero", }, { title: "Sword Adventure", value: "Sword Adventure",
description: "This game is an easily customizable template for developing an Excalibur game with Ionic React, the XState library, i18next, Twine integration for dynamic dialogs, and CapacitorJS. It comes with scene transitions, data persistence and tutorials included!", url: "https://nicastro.in/excalibur-games/sword-adventure", source: "https://github.com/facondiaGames/sword-adventure", }, { title: "Beach Breach", value: "Beach Breach",
description: "This game was created for Ludum Dare 50. Defend your sandcastle from crabs, turtles, and seagulls in this beach-themed tower defense game!", url: "http://excaliburjs.com/ludum-50/", source: "https://github.com/excaliburjs/ludum-50", }, { title: "Meerkattica", value: "Meerkattica",
description: "This game was created for Ludum Dare 48. Dig deeply and quickly to get to your next metal gig, but watch out for the mechanical snake that pursues you!", url: "http://excaliburjs.com/ludum-48/", source: "https://github.com/excaliburjs/ludum-48", }, { title: "The Show Must Go On", value: "The Show Must Go On",
description: "This game was created for Ludum Dare 46. Keep the theater production going as the only actor!", url: "http://excaliburjs.com/ludum-46/", source: "https://github.com/excaliburjs/ludum-46", }, { title: "Office Daydream", value: "Office Daydream",
description: "This game was created for Ludum Dare 41. Balance the needs of your job with the needs of your dream!", url: "http://excaliburjs.com/ludum-41/", source: "https://github.com/excaliburjs/ludum-41", }, { title: "I Just Wanted Groceries", value: "I Just Wanted Groceries",
description: "This game was created for Ludum Dare 38. Avoid talking to people and finish your shopping!", url: "http://excaliburjs.com/ludum-38/", source: "https://github.com/excaliburjs/ludum-38", }, { title: "Hexshaper", value: "Hexshaper",
description: "This game was created for Ludum Dare 35. Absorb enemy projectiles and close the portals!", url: "http://excaliburjs.com/ludum-35/", source: "https://github.com/excaliburjs/ludum-35", }, { title: "Crypt of the Minotaur", value: "Crypt of the Minotaur",
description: "This game was created for Ludum Dare 33. Play as the Minotaur to defend your treasure!", url: "http://excaliburjs.com/ludum-33/", source: "https://github.com/excaliburjs/ludum-33", }, { title: "Sweep Stacks", value: "Sweep Stacks",
description: "This game was created for Ludum Dare 31. Sweep across the screen to clear blocks!", url: "http://excaliburjs.com/sweep/", source: "https://github.com/excaliburjs/sweep", }, { title: "Kraken Unchained", value: "Kraken Unchained",
description: "This game was created for Ludum Dare 29. Play as the Kraken and destroy ships!", url: "http://krakenunchained.azurewebsites.net", source: "https://github.com/excaliburjs/Ludum-29", },];
// NOTE: known duplicate entries in this data (typescript_excalibird twice,// doubled Spritefusion) — the MCP create tool dedupes defensively; the data// fix is tracked separately, so no uniqueness assert here yet.export const SAMPLES: TemplateDefinition[] = [ { name: "🐦 Excalibird (Flappy Bird Clone)", value: "typescript_excalibird", description: "", repo: "https://github.com/excaliburjs/sample-excalibird", startCommand: "npm run start", }, { name: "🐸 Jelly Jumper (Mario Clone)", value: "typescript_excalibird", description: "", repo: "https://github.com/excaliburjs/sample-excalibird", startCommand: "npm run start", }, { name: "🥾 Platformer", value: "typescript_platformer", description: "", repo: "https://github.com/excaliburjs/sample-platformer", startCommand: "npm run start", }, { name: "📈 Grid Based Movement", value: "typescript_grid", description: "", repo: "https://github.com/excaliburjs/sample-grid", startCommand: "npm run start", }, { name: "♟️ Tactics", value: "typescript_tactics", description: "", repo: "https://github.com/excaliburjs/sample-tactics", startCommand: "npm run start", }, { name: "💻 React UI", value: "typescript_react", description: "", repo: "https://github.com/excaliburjs/sample-react", startCommand: "npm run start", }, { name: "💻 Vanilla HTML UI", value: "typescript_html", description: "", repo: "https://github.com/excaliburjs/sample-html", startCommand: "npm run start", }, { name: "🗺️ Tiled Tile Maps", value: "typescript_tiled", description: "", repo: "https://github.com/excaliburjs/sample-tiled-vite", startCommand: "npm run start", }, { name: "🗺️ LDtk Tile Maps", value: "typescript_ldtk", description: "", repo: "https://github.com/excaliburjs/sample-ldtk", startCommand: "npm run start", }, { name: "🗺️ Spritefusion Tile Maps", value: "typescript_spritefusion", description: "", repo: "https://github.com/excaliburjs/sample-spritefusion", startCommand: "npm run start", }, { name: "🗺️ Spritefusion Tile Maps", value: "typescript_spritefusion", description: "", repo: "https://github.com/excaliburjs/sample-spritefusion", startCommand: "npm run start", }, { name: "🎯 Pathfinding", value: "typescript_pathfinding", description: "", repo: "https://github.com/excaliburjs/sample-pathfinding", startCommand: "npm run start", }, { name: "📦 Matter.js", value: "typescript_matterjs", description: "", repo: "https://github.com/excaliburjs/sample-matterjs", startCommand: "npm run start", },]