Manual
Manual
The Abyss Manual
Abyss is a game engine built on Bevy, with C# for your game's code, Rust where you want it, and an editor to build your scenes in. This manual covers what the engine and the editor do and how to use them.
Start here
If you are new to Abyss, read these in order:
- Install the Hub and an engine version.
- Your first project: make one from a template and press Play.
- The editor's windows: what each panel is for.
- Build and run your game on Windows, macOS, Linux or the web.
How Abyss works
These pages explain the ideas the rest of the manual builds on:
- Entities, components and systems: the data model every game is made of.
- Scenes and prefabs: how a game's worlds are saved, loaded and reused.
- Assets, identities and addresses: how files become what a game draws and plays, and how code finds them.
- C# in a game: components, systems and plugins written in C#.
- Rust in a game: the same written in Rust, beside the engine.
The editor
- The Hierarchy, the Inspector, the Scene view, the Project panel, the Game view and the Profiler, each in depth.
Making a game
| Topic | Pages |
|---|---|
| Scripting | Systems and schedules, transforms, layers, a game's start, flows and services, player preferences, noise and random numbers, components from Rust and Bevy, performance |
| Graphics | Cameras, lights, meshes and materials, textures, models, shaders, the window and display |
| 2D | Sprites, tilemaps, 2D lights, 2D cameras |
| Animation and audio | Animation clips, the Animator, sounds and audio sources, buses and effects |
| UI and input | UI documents and controls, style sheets, UI from code, input actions, keyboard, mouse and gamepads |
| Effects | Particle Emitter, Trail, Line, Particle Force Field |
| Physics and navigation | Physics 2D, Physics 3D, Navigation |
| Packages and the web | Using packages, making a package, calling JavaScript |
Tutorials
Step by step: coming from another engine, and a first 3D game or a first 2D game.
