DuskDusk
Get started
GET STARTED / FIND YOUR BEARINGS

Your first world
starts here.

Run the source project locally, then choose a path: explore Darkwind, create in the atelier, or build a game in TypeScript.

01

Bring the engine home.

Clone Dusk and install its dependencies. Run the following commands in your terminal.

TERMINAL
git clone https://github.com/jasona/dusk-engine.git
cd dusk-engine
npm ci
02

Choose your first path.

All three begin from the repository you just cloned.

Enter Darkwind.

Start the furnished house-and-garden preview. The launcher also prints a private editor link.

TERMINAL
npm run dev:darkwind

Open localhost:5187. Open the same address in a second browser profile to meet another traveler.

W A S D MoveE InteractEsc Menu

Look with the mouse or arrow keys. Audio is opt-in. Keep the terminal running, and use Ctrl+C to stop. The preview uses its own saved room at .data/arrival-art.10.

Full game guide

Shape a world visually.

Start World Atelier to select and transform objects, import assets, and author your first place.

TERMINAL
npm run dev:editor

Open the private /editor.html#key=… link printed in your terminal. The default atelier runs on port 5181.

Keep the access key private. Draft changes stay separate from published worlds. Save your draft, try a shared development room, and publish an invitation when ready.

World Atelier guide

Follow a complete SDK game.

The Meridian is a complete cooperative puzzle that imports only the public SDK. Start it, explore the source, and build a release.

TERMINAL
npm run dev:meridian

Leave the preview running. In another terminal, from the engine repository, build the example and generate its API reference.

TERMINAL
npm run game:build -- games/cooperative-puzzle/game.ts /tmp/meridian-release.json
npm run sdk:reference

The local game opens on port 5188. The SDK is currently a source API inside the engine repository. The release builder refuses to overwrite an existing output file; choose a fresh path when rebuilding.

SDK & presentation adapters
03

Follow the next thread.

Read the first guide

An overview of Dusk and its source project.

Bring a model

Import GLB content into your world.

Publish an invitation

From draft content to a saved playtest.

Plan a hosted room

Profiles, persistence, and deployment scope.

GOOD TO KNOW

A little orientation.

Does a player need to install the engine?

The player runs in a WebGPU-capable browser. As a developer, you run the source project or serve a built release. This site’s quick start uses a local development server.

Can I use the editor and TypeScript together?

Yes. Dusk has a browser authoring workspace and a source SDK. Follow the authoring and SDK guides for the saved-world and game-presentation contracts.

Is Dusk ready for a large public world?

Dusk is an early beta. Darkwind’s current shared-play target is two desktop WebGPU travelers. Broader device and performance qualification remain open, and the pinned beta’s Docker acceptance still awaits an external result. Read the release record and capacity measurements.

Where do saves go?

The Darkwind arrival preview uses .data/arrival-art.10; The Meridian uses .data/meridian.1. The packaged default profile uses .data/hearth. Stop an existing process before restarting it after source updates. See the game and hosting guides before moving saved data.

Can I deploy with Docker or Coolify?

The source repository includes Docker Compose profiles and a Coolify guide. Keep the exact tested revision and remaining acceptance status in view. Read the hosting guide.

FIND YOUR BEARINGS
Search the complete Field Guide.
↑↓ navigate ↵ openOpen full search