Home

Documentation for Aurelia, the command-line Steam client and launcher for Linux and Windows.

The repository's own README covers the pitch, install, and quick start. Everything deeper lives here.

Important

Prefer the Windows build + Proton, even when a game has a native Linux port.

Running the Windows version of a game through Proton is always the best-supported path in Aurelia. Native Linux ports are implemented inconsistently from developer to developer, so not every case can be handled, and the support rate for Linux ports is correspondingly low.

If you run into problems with a Linux port and would like Aurelia to support it, please open an issue. Support for a title usually requires owning it, so if you want to help with testing, consider sponsoring the project on GitHub.

User documentation

Page	Contents
Usage	Full reference for every command and flag (index, with one page per area listed below)
Windows Steam Runtime	The self-contained Wine Steam prefix (steam-runtime): setup, requirements, troubleshooting

Usage reference pages

• Global behavior
• Authentication
• Library
• Store & discovery
• Collections
• Installation & maintenance
• Launching
• Depots & branches
• Downgrade & version pinning
• Steam Cloud
• Steam Workshop
• Friends & chat
• Inventory, wallet & market
• Configuration
• Proton & Wine runtimes
• Windows Steam runtime
• Luxtorpeda native-engine plugin (Linux only)
• umu-launcher plugin (Linux only)
• Launch scripts
• Session daemon
• Files & locations
• Exit codes & logging

Maintainer documentation

Page	Contents
Releasing	How to cut a release and publish per-platform binaries
Files Reviewed	Provenance / manual-review checklist for every file in the repository

Architecture reference

A per-subsystem architectural reference generated from a full read of the src/ tree and the integration test suite. Start at the overview.

#	Page
00	Overview
01	CLI Surface & Entry Flow
02	Config, Data Models & Persisted Store
03	Steam Client Core
04	Steam Content Download / Install
05	Steam Library & Game Launch
06	Steam Social
07	Workshop & Community Market
08	Library, Local Install Scanning & CM Server List
09	The Staged Launch Pipeline
10	Launch Validation & DLL Provider Resolution
11	Proton / Wine Runtime Management & the Runner Abstraction
12	Cloud Sync & Install Relocation
13	The Background Session Daemon
14	Infra: Logging & Observability
15	Shared Utilities & Standalone Modules
16	Integration Test Suite
17	The umu-launcher Runner

Contributing

Contribution guidelines, the code of conduct, the security policy, and the license stay in the main repository: CONTRIBUTING · CODE_OF_CONDUCT · SECURITY · LICENSE