Ambient Getting Started Tutorial

Ambient is a game engine written in Rust, focusing on modding and multiplayer features.

In this tutorial, we will write a simple shooting game from scratch, and in the process, we will show you the basic features of the engine, providing resources such as documentation, reference, examples, games, etc. Hopefully this will give you a good idea of how to use Ambient to make your own game.

Prerequisites

Rust 1.67 or later is required to build Ambient. You can install Rust by following the instructions on rustup.rs.

Rust programming experience is not required to follow this tutorial, but it is recommended. If you are new to Rust, you can learn the basics of the language on rust-lang.org.

After installing rust, you should be able to use command line tool including rustup and cargo.

You need to run rustup target add --toolchain stable wasm32-wasi in your Terminal. This will install the WebAssembly target for the WASI platform, which is required to build Ambient.

Then you can use the cargo install command to install Ambient:

cargo install --git https://github.com/AmbientRun/Ambient.git --rev ad24915e58 --locked --force ambient

Done!

If you prefer other methods for installation, see here.

It's also recommended to setup your IDE for a better Ambient dev experience (see here).

Tutorial structure

This tutorial is divided into several chapters. Each of them comes with a full Ambient project code with explainations. You can find them in each branch of this repository, or you can click the links below to see:

• Chapter 1: Project Structure
• Chapter 2: Colliders and Async
• Chapter 3: Spawn query
• Chapter 4: Message
• Chapter 5: Input from users
• Chapter 6: Move character with physics
• Chapter 7: Model import
• Chapter 8: Animation
• Chapter 9: Bind a gun
• Chapter 10: Bind the camera
• Chapter 11: UI
• Chapter 12: Raycast