amethyst 0.2.1

Data-oriented game engine written in Rust
Documentation

Amethyst

Build Status Crates.io MIT License 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.

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 Stringray). 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, especially in rendering.
  • Correct entity-component-system model, with entities and prefabs largely defined in YAML 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.

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_tools
$ amethyst new mygame
$ cd mygame
$ amethyst 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.

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? See the Development Roadmap on our wiki, or search though our issue tracker.