Amethyst

Warning: The book and tools repository are severely out of date at the moment. Amethyst is undergoing a lot of changes at the moment so if you are looking to use the library it would be better to just read the examples.

This project is a work in progress and is very incomplete; pardon the dust! Read a summary of what happened this past week at This Week in Amethyst.

Documentation

Vision

Amethyst is a fast, data-oriented, and data-driven game engine suitable for rapid prototyping and iteration. It also tries to push the Rust programming language to its limits, driving further improvement and hopefully attracting more game developers toward the young and vibrant Rust ecosystem.

The engine's design draws much inspiration from the industrial-strength Bitsquid Engine (now called Autodesk Stingray). However, Amethyst does not aim to be API-compatible with it in any way. Some goals include:

• Simple game state management in the form of a pushdown automaton.
• Massively parallel architecture.
• Correct entity-component-system model, with entities and prefabs largely defined in Ron files.
• Abstract scripting API that can be bound to a variety of embedded languages, such as mruby, Lua, etc.
• Renderer optimized for modern graphics APIs, e.g. Vulkan, Direct3D 12+, Metal.
• Easy integration with useful third-party game development libraries, e.g. Piston.
• Traditional "mega-editor" split into several small but well-integrated tools, adhering to the Unix philosophy.

Usage

Read the online book for a comprehensive tutorial to using Amethyst. There is also an online crate-level API reference.

Getting started

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.

Dependencies

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

Ubuntu

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

Fedora

$ sudo yum install alsa-lib-devel

Building Documentation

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.

Questions / Help

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 an easy question, just ask on Gitter 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.

License

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

Contributing

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.