Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Asset Pack

Rusty Engine assumes the asset pack is present, so you MUST download the asset pack.

Here are three different ways to download the assets (pick any of them–it should end up the same in the end):

  • RECOMMENDED: In your terminal with a posix-compatible shell, run this command inside your project directory:
curl -L https://github.com/CleanCut/rusty_engine/archive/refs/heads/main.tar.gz | tar -zxv --strip-components=1 rusty_engine-main/assets
  • OR, clone the rusty_engine repository and copy/move the assets/ directory over to your own project
  • OR, download a zip file or tarball of the rusty_engine repository, extract it, and copy/move the assets/ directory over to your own project.

Asset Directory Structure

All assets reside inside an assets/ directory at the top folder of your Rust project (in the same directory as Cargo.toml).

The structure looks like this:

assets
├── audio
│   ├── music
│   └── sfx
├── fonts
└── sprite
    ├── racing
    └── rolling

You can organize your own custom files inside the assets folder wherever you like, but the provided asset pack is organized like this:

  • Audio files in assets/audio. The asset pack divides sounds into music and sfx subdirectories.
  • Font files in assets/font.
  • Sprites (images and colliders) in assets/sprite.