Docssdk 0.0.0Aether homeOpen Aether

Build for Aether

Build a game system, content module, or capability-gated mod against the contracts Aether runs today.

2 minute read

Aether is a game-agnostic tabletop platform. The engine supplies documents, scenes, permissions, rolls, automation, and sandbox boundaries. A package supplies the game vocabulary or the optional feature.

Code-extension guides currently use the Aether source checkout because the @aether/* packages and the aether CLI are private workspace packages. Portable Soundscape packages use a separate browser path: export from a world, then publish through Creator Studio with a signed-in Aether account.

#Choose the extension surface

You want to buildUseCurrent distribution
A game's document types, native sheets, initiative, and automationsystemsource checkout and host registration; one active system per world
Reusable types, documents, and assetsmodule or content packsource checkout and host composition
A panel, scene tool, chat command, or other engine extensionmodsandboxed app installed from a local manifest
Cues, groups, sequences, layers, and their audioSoundscape packageexport from a world; publish through Creator Studio

Systems currently reach a world through source checkout and host registration. Marketplace system installation is a separate future distribution path.

#Start with a running system

Build your first system scaffolds a package, registers it with the local CLI, creates a world, and runs that world in the browser. The guide uses only commands that exist in this repository.

#Publish a Soundscape from the browser

Export and publish Soundscape packages starts in a world where you are the GM, carries the audio and definitions into one portable file, and finishes in Creator Studio. The guide uses the signed-in product interface from export through Marketplace publication.

#Learn the contracts

The maintained examples page maps each surface to an exact package, source file, and verification command.

Was this page helpful?