Aaron Housh
d1906a5072
|
5 years ago | |
---|---|---|
resources | 6 years ago | |
src | 5 years ago | |
.gitignore | 6 years ago | |
COPYING | 5 years ago | |
Cargo.lock | 6 years ago | |
Cargo.toml | 6 years ago | |
README.md | 6 years ago |
README.md
Amethyst 2D Starter
This project template will get you from 0 to drawing something on the screen in no time. If you're looking for a more in-depth introduction to the engine, please have a look at our book!
Quickstart
- Clone the repository
git clone https://github.com/amethyst/amethyst-starter-2d.git
cd amethyst-starter-2d
- Build and run the project
cargo run
For Mac Users
This starter uses vulkan as a renderer by default. You'll want to change the backend to use metal
, which can be done by opening the Cargo.toml
file and changing
[features]
default = ["vulkan"]
to
[features]
default = ["metal"]
For Linux Users
You might need to install some dependencies. Please refer to this section of the README for more details.
Features
This project contains the minimum amount of code needed to draw sprites to the screen. Here's a small summary of what you'll find in the source files:
-
resources/display_config.ron
Contains the window configuration (size, title). -
src/main.rs
Creates the render graph, adds the required bundles, builds the game data with our own state and finally, starts the game's main event loop. -
src/render.rs
Configures the RenderGraph, which defines draw passes, color formats and so on. -
src/state.rs
Implements the main game state. In theon_start
hook, the camera is initialized, and the sprites that will be drawn are loaded and their entities created.
In thehandle_event
hook, we print any keys that were pressed and close the window if the user presses escape or the OS requests that we quit.