Skip to Content
Getting Started

Getting Started

Prerequisites

  • Bun
  • Node-compatible shell
  • optional: yt-dlp for the research transcript path
  • optional: provider credentials in the macOS keychain for real image generation

Install

From the repo root:

bun install

Run the docs app

cd apps/docs
bun run dev

Local docs run on:

http://localhost:3001

Build

cd apps/docs
bun run build

Useful repo checks

bun run build
bun run typecheck
cd packages/warline && bun run test

Where work lives

PathPurpose
apps/docsNextra docs app for docs.shipshit.games
apps/webStudio site for shipshit.games
apps/desktopElectron studio cockpit
apps/warlineWarline hub app
packages/assetgenAsset generation CLI/core
packages/researchTutorial-to-rules CLI/core
packages/warlinePure world model and client contract
packages/engineShared Three.js game engine primitives
packages/uiShared UI package
../deadrotcomPlayer-facing hub and shipped game repos
../loreCanon source of truth
Tools Overview