Subscribe Free

Join 2670+ others. No spamming.
I promise!

We are currently under high development. Follow us at github.


Looking for Python Tutorials?
Check these awesome tutorials



amethyst/amethyst

205

amethyst / amethyst

Rust

Data-oriented game engine written in Rust


READ ME

Amethyst

Build Status Crates.io MIT/Apache Join the chat

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 aims to be 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:

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 cargo and build it. Follow along below:

$ cargo new mygame --template https://github.com/amethyst/project_template
$ cd mygame
$ cargo run

If everything goes well, you should see the following print out to the terminal:

Game started!
Hello from Amethyst!
Game stopped!

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.

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, read our roadmap, 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.