Create a Federated Planet

Scaffold a new planet for the Federated Planets universe — a decentralized space exploration game where every planet is a sovereign website.

Usage

npm create planet

The interactive setup will ask you for:

• Output directory — where to scaffold the project
• Planet name — displayed on your landing site and shared with neighboring planets
• Planet description — shown to visitors on your landing site
• Warp links — URLs of neighboring planets to link to (leave empty for defaults)
• Cloudflare worker name — the name of your Worker on Cloudflare

It will then generate a ready-to-deploy wrangler.deploy.jsonc configured with a Durable Object for storage.

Prerequisites

• Node.js 18+
• Wrangler authenticated with your Cloudflare account (npx wrangler login)

After Scaffolding

cd my-planet
npm install
npm run dev        # local development

To deploy, connect your project to Cloudflare Workers CI and set:

• Build command: npm run build
• Deploy command: npx wrangler deploy

What Gets Created

my-planet/
├── src/
│   ├── pages/            # Astro pages (landing site, space port, manifest)
│   └── lib/              # Protocol logic (consensus, crypto, travel)
├── public/               # CSS, 3D star map (Three.js), static assets
├── scripts/              # Dev utilities (simulate universe, inject DO exports)
├── wrangler.deploy.jsonc # Generated with your worker name and Durable Object config
├── wrangler.dev.jsonc    # Local development config
└── package.json

Learn More

• Federated Planets specification
• Space Travel Protocol
• Planet reference implementation