Zelda Hessler edited this page Jan 14, 2018 · 57 revisions

Welcome to the Amethyst wiki! This wiki is still being built, so some things may be missing or incomplete. If you have any questions, please ask them on Gitter.


  • Game developers should read the Amethyst Book.
  • A crate-level API reference can be found here.
  • A glossary of common terms can be found here.

Package List

Design Documents

These pages describe the overall design for Amethyst going forward. Anyone willing to contribute to these documents must read all the links in the "Design Inspiration" section of the Contribution Guidelines.

Amethyst's overall design is very much in a nebulous state right now, but you can peek at the details if you're interested in what it could become. The design documents might not necessarily reflect the final representation and are not always updated.