/amethyst

Data-oriented game engine written in Rust
  1. Rust 98.6%
  2. GLSL 1.4%
Rust GLSL
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@bors[bot] @jojolepro
bors[bot] and jojolepro Merge #822 
822: Renamed is_key to is_key_down. r=Xaeroxe a=jojolepro

Examples now react when the key is pressed instead of released.

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/amethyst/amethyst/822)
<!-- Reviewable:end -->


Co-authored-by: Jojolepro <jojolepromain@gmail.com>
Latest commit 8662b76 Jul 18, 2018
Permalink
Failed to load latest commit information.
amethyst_animation Derive `PartialEq` for `MaterialPrimitive`. Jul 2, 2018
amethyst_assets Bump specs version to 0.12 Jul 12, 2018
amethyst_audio Improve compile times by synchronizing dependencies Jul 3, 2018
amethyst_config Add file path to config error reporting Jul 10, 2018
amethyst_controls rustfmt-stable pass Jun 20, 2018
amethyst_core Bump specs version to 0.12 Jul 12, 2018
amethyst_gltf fix: Generate tangents if missing in GLTF Jun 14, 2018
amethyst_input Renamed is_key to is_key_down. Also fixed so that examples do somethi… Jul 17, 2018
amethyst_locale rustfmt-stable pass Jun 20, 2018
amethyst_renderer Convert various prints to log macros Jul 10, 2018
amethyst_ui Convert various prints to log macros Jul 10, 2018
amethyst_utils feat: Improved ergonomics of examples by using prefabs Jun 15, 2018
book Renamed is_key to is_key_down. Also fixed so that examples do somethi… Jul 17, 2018
docs Updated changelog Jul 17, 2018
examples Fixed examples not building Jul 17, 2018
src Bump specs version to 0.12 Jul 12, 2018
.appveyor.yml Add sdl2 installation to appveyor.yml Jul 11, 2018
.gitattributes Fix crlf normalization on extensionless files Mar 8, 2017
.gitignore Update .gitignore for mdbook output directory. Apr 10, 2018
.travis.yml Add sdl2 installation to travis.yml Jul 11, 2018
COPYING Move some files from the root directory into docs Mar 12, 2018
Cargo.toml Implement SDL based controller input system under a feature gate Jul 11, 2018
README.md Update Fedora install command in readme Jul 10, 2018
bors.toml Update bors.toml Jan 7, 2018
build.rs Updating specs to 0.10, shred to 0.5, and rayon to 0.8. Using Restric… Oct 8, 2017
rustfmt.toml Formatting with 0.4.2-stable May 31, 2018

README.md

Amethyst

Build Status Crates.io MIT/Apache Join the chat Join us on Discord Lines of Code

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.

Goals

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

Features

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

Documentation

develop docs master docs

Usage

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

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 dnf 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 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.

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.