Skip to Content
Getting Started

Getting Started

Prerequisites

  • Bun
  • Node-compatible shell
  • optional: yt-dlp for the ressources 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

Where work lives

PathPurpose
apps/docsNextra docs app for docs.shipshit.games
apps/webStudio site for shipshit.games
apps/desktopElectron studio cockpit
packages/assetgenAsset generation CLI/core
packages/ressourcesSource library, transcript capture, and tutorial-to-rules CLI/core
packages/engineCanonical @shipshitgames/engine package and shared Three.js game primitives
packages/uiShared UI package
../deadrotcomPlayer-facing hub, Warline, shipped game repos, and Deadrot runtime assets
../loreCanon source of truth
Tools Overview