Manual
Manual
Install the Hub
Abyss Hub is the launcher for Abyss Engine: it installs engine versions, makes and opens your projects, and signs your computer in to abyssengine.net. This page covers installing the Hub, adding an engine version and the tools games are built with, and signing in.
What the Hub does
The Hub is a small desktop app with no engine of its own in it. Its sidebar has two pages:
- Projects lists your games, the most recently opened first, each with the engine version it is made with. Open starts the editor of that version. New Project makes a game from a template (see Your first project).
- Installs lists the editors on your computer and the engine versions you can download. Each engine version is an editor of its own, so you can keep several side by side.
Each project names its engine version in its C# project file, for example <Project Sdk="AbyssEngine.Sdk/0.4.0" />. That is how the Hub knows which editor to open it in, and why two projects on one computer can use different versions.
Download and install the Hub
The download page offers the latest Hub for each platform:
| Platform | Runs on |
|---|---|
| Windows | 64-bit, Windows 10 and later |
| macOS | Apple silicon |
| Linux | 64-bit (x64) |
To install it:
- Open abyssengine.net/download. The card for your platform comes first.
- Download the installer for your platform and run it.
- Start Abyss Hub.
The Windows installer is not code-signed yet, so Windows may warn that it comes from an unknown publisher.
Updates
The Hub keeps itself up to date. As it starts, and every four hours after, it checks for a newer version, downloads it in the background, and shows Restart to update above your account. If your Hub is older than the oldest version the website still works with, a banner across the top offers Update Now. On a Mac, Abyss Hub ▸ Check for Updates… checks at once.
Install an engine version
- Click Installs in the sidebar.
- Under FROM ABYSSENGINE.NET, pick a channel, such as Stable, or All to list every version.
- Click Install beside the version you want.
The Hub downloads the editor, checks the download against the SHA-256 hash the website signed, and unpacks it. The new editor is listed under ON THIS COMPUTER. Installing does not need you to be signed in.
You do not have to install a version before you need it. A project whose version is not on your computer shows Install and Open in its row, which installs the editor and then opens the project.
Other actions on the Installs page:
- Locate… adds an editor you built or unpacked yourself, by its executable.
- The trash button removes an editor the Hub installed. For an editor you located, it only takes it off the list.
The tools games are built with
The editor compiles your game, so your computer needs a few developer tools. Each engine version says which it needs, and the Hub checks for them when you install an editor and each time you open a project.
| Tool | What it is for | Platform |
|---|---|---|
| .NET SDK 10 | Building your game's C# scripts. The editor needs it to open a project. | All |
| Rust | Building your game into an executable, and building any Rust code in your game or its packages | All |
| Visual Studio C++ Build Tools (version 17, Visual Studio 2022) | Linking your game's executable | Windows |
| Xcode Command Line Tools | Linking your game's executable | macOS |
Libraries games build against (pkg-config, the ALSA, udev, X11 and xkbcommon development packages, clang and zlib's) | Building your game for Linux | Linux |
If any tool is missing or older than the editor needs, the Hub lists them on a sheet headed with the version, such as Abyss Engine 0.4.0 needs. Tools already on your computer are ticked. From the sheet:
- Install (or Update) runs the tool's own installer: Microsoft's
dotnet-installfor the .NET SDK, into your own folder;rustupfor Rust; Apple's installer for the Xcode tools; and the Visual Studio Build Tools installer with the C++ workload, which asks for administrator rights. - On Linux, the sheet shows the
sudo apt installcommand for the missing libraries, with Copy, for you to run in a terminal. - Install All installs everything missing, in order.
- Check Again looks again after you install something yourself.
- Open Anyway opens the editor without the missing tools. The editor tells you what a build lacks when you build.
Once everything is there, the project opens by itself.
A few more things depend on your platform:
- Linux: the editor needs glibc 2.38 or later, as in Ubuntu 24.04, Debian 13, Fedora 39 and newer.
clangand zlib's development headers are what .NET's ahead-of-time compiler links a game with; editors before 0.1.5 do not list them, so install them yourself there. - Web builds need Web Build Support, which the editor installs for you the first time you build for the web. See Build and run your game.
- Android builds need Android Studio with its NDK, and Android Build Support, which the editor installs for you the first time you build for Android. See Build for Android.
Sign in
Signing in connects your computer to your abyssengine.net account.
- Click Sign in at the foot of the Hub's sidebar. Your browser opens abyssengine.net.
- Sign in on the website if you are not already, and say yes to the Hub. While it waits, the sidebar shows Signing in… (cancel).
- Once you say yes, the sidebar shows your account. Its menu has My Assets, Access Tokens and Sign Out.
You sign in once per computer. The sign-in is kept in your system's own store of secrets: Credential Manager on Windows, the keychain on macOS, and the Secret Service on Linux. The Hub and every editor on the computer read the same sign-in, so signing in or out in one of them does it in all of them. In the editor, the same sign-in is Sign In at the right end of the menu bar.
The sign-in is an access token named after your computer. It lasts a year, and you can revoke it on the website's Access tokens page.
You need to be signed in for what belongs to your account: templates and packages from the website, and your My Assets. Installing editors, the editor's own templates and the engine's own packages work without it.
Where the Hub keeps things
The Hub keeps everything in your own user folder, %LOCALAPPDATA%\AbyssEngine on Windows and ~/.local/share/AbyssEngine on Linux, so neither it nor the editors it installs need administrator rights:
| Path | What it holds |
|---|---|
hub.json | The projects listed, the editors located elsewhere, and where you last made a new game |
Editors\<version> | Each editor the Hub installed |
Templates | Templates downloaded from the website, so a second game made from one downloads nothing |
Logs | What each tool's installer printed |
Next, make a game: Your first project.
