Installation

Install the published CLI when you want to play the terminal game, or run the repo scripts when you are developing the game and website locally.

Player install

The curl installer downloads the matching macOS or Linux release binary when GitHub release assets are available, then falls back to the published npm package. The global package exposes opendungeon for the TUI and opendungeon-host for hosted lobby work. Login is optional for local play. Use the test login while checking account-gated flows without a real provider.

Local development

bun run dev starts the terminal client from source. bun run headless runs gameplay scripts without drawing the terminal UI. bun run web starts the Next.js website through Portless at https://opendungeon.localhost.

Website development

The website lives in packages/www. It uses Next.js, the shadcn preset, Biome through Ultracite, and Portless for the local HTTPS host.

If the dev server reports a .next/dev/lock error, another Next process is still running. Stop the old process before starting a new one so Portless can point opendungeon.localhost at the current server.