Warning: The engine is still in alpha, and thus it changes very fast. You may find out that some parts of the documentation can be outdated. If you find such an occurrence, feel free to open an issue and it will be fixed in no time.

• Massively parallel architecture
• Powered by a correct Entity Component System model
• Rapid prototyping with RON files for prefabs and an abstract scripting API

Please visit the features page for a list of features Amethyst provides and will provide.

Please read the online book for a comprehensive tutorial to using Amethyst.

To compile any of the examples run:

$ cargo run --example name_of_example

All available examples are listed under examples.

For a full-blown "Hello World" tutorial check out the Getting Started chapter in the book.

If you are compiling on Linux make sure to install the following dependencies:

$ sudo apt install libasound2-dev libx11-xcb-dev

$ sudo dnf install alsa-lib-devel

You can build the book locally with:

$ cargo install mdbook
$ mdbook build book

The text can be found in book/html/index.html. To generate the API documentation locally, do:

$ cargo doc

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

We do not support anything other than the most recent Rust stable release. Use nightly and beta channels with this project at your own risk.

Please check out the FAQ before asking.

If you have a question, just ask on Gitter or Discord and we'll help you and add it to the FAQ.

Other places you may want to check out are r/rust_gamedev and #rust-gamedev IRC.

Amethyst is free and open source software distributed under the terms of both the MIT License and the Apache License 2.0.

We are a community project that welcomes contribution from anyone. If you're interested in helping out, please read the CONTRIBUTING.md file before getting started. Don't know what to hack on? Check our active projects, or search though our issue tracker.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.