Getting started
Setting up Rust
We recommend using rustup to easily install the latest stable version of rust. Instructions should be on screen once rustup is downloaded.
Required dependencies
If you are on Linux, you'll need to install libasound2-dev and libx11-xcb-dev.
Setting up Amethyst
You can either use the Amethyst CLI or just cargo to set up your project. After executing
amethyst new game
you should get Cargo.toml, src/main.rs and resources/display_config.ron.
In case you're doing this with cargo, here's what you need to do:
- Add
amethystas dependency in yourCargo.toml. - Create a
resourcesfolder and put adisplay_config.ronin it. - Start with one of the [examples][ex] from the Amethyst repository (e.g.
window) for the source code. Watch out to use the right example for the version of Amethyst you specified inCargo.toml.
We don't have any tutorials yet, but there's a Gitter room where you can ask in case you want an explanation for something. If you'd like to help out, a tutorial would be much appreciated!