Amethyst

Experimental data-oriented game engine written in Rust. This project is a work in progress and very incomplete; pardon the dust!

Usage

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

Quick Example

See the Getting Started chapter in the book for the full-blown "Hello, World!" tutorial. For the sake of brevity, you can generate an empty game project with the amethyst_cli tool and build it. Follow along below:

$ cargo install amethyst_cli
$ amethyst new mygame
$ cd mygame
$ amethyst run

If everything goes well, you should see "Hello from Amethyst!" print out to the terminal and abruptly exit.

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.

Contributing

Amethyst is an open-source project that values community contribution. Pull requests are welcome!

We assume you have granted non-exclusive right to your source code under the MIT license and you have processed your code with rustfmt prior to submission. If you want to be known as an author, please add your name to the AUTHORS.md file in the pull request.

See the Development Roadmap for ideas on what you can hack on.