Temporary Amethyst Documentation

We are moving our docs from sub-domains into the new Amethyst.rs

Stable (0.15.x)

Book API

Main Branch (0.16.x)

The Main branch documentation is currently not available online, you can build it locally from the repo


cargo install mdbook
mdbook build book

If you're actively editing the book, it's easiest to run:

mdbook serve book

and navigate to http://localhost:3000


To generate the API documentation locally, do:

cargo doc

The API reference can be found in target/doc/amethyst/index.html.

Amethyst.rs Github Repo Amethyst Forums