How it fits together
From the player's launcher to a gamemode's database, with how sure we are that each part exists.
From the player's launcher to a gamemode's database. Every part is marked with how sure we are that it exists:
- Live: running and verified by a test or a person.
- Built: in the source code and building, but not yet released.
- Planned: on the roadmap, not built yet.
From click to city#
| Where | Part | What it does | State |
|---|---|---|---|
| Player's PC | Launcher | Server list with live status, settings, joins a server | In testing (no download yet) |
| Player's PC | Client | The Alt:SA engine (Unity) | Live |
| Player's PC | GTA SA files | Your own copy | Required |
| Server host | Dedicated server | The same engine, headless, with a status endpoint | In testing (no download yet) |
| Server host | Gamemode | A C# plugin, e.g. Hello-Godfather (NG-RP next) | In testing |
| Server host | Godfather-API | Players, camera, UI kit, storage, accounts (v0.2) | In testing |
| Server host | Storage | SQLite on the host (data/godfather/godfather.db), accounts with salted slow hashes | In testing |
| Server host | GTA SA files | The host's own copy | Required |
The client connects to the server with Mirror over TCP port 7777. The server loads the gamemode, and the gamemode talks to players through Godfather.
What happens when you join#
- You pick a server in the launcher. The launcher asks each listed server for its name, players and gamemode.
- The client starts and connects. It loads your GTA SA files, then joins the server over the network.
- The server's gamemode takes over. On NG-RP that is a camera fly-over and the sign-in dialog, drawn with the UI kit.
- The server stays in charge. Game state, such as a car's engine, is decided on the server and synced to every player.
Where the code lives#
All repositories are private for now. Each has a README, an agent guide, a changelog and a roadmap.
| Repository | What | State |
|---|---|---|
| Alt-SAMP/Engine | The Unity engine: client and dedicated server | Live |
| Alt-SAMP/Brand | Logos, icons and design tokens | Live |
| Alt-SAMP/Website | This site and wiki | Live |
| Alt-SAMP/Godfather-API | Gamemode API and its docs | v0.2 |
| Knot-Vector/NG-RP | The first community: gamemode and site | Planned |
| Knot-Vector/Agent-Toolkit | Skills and tools for the agents building all of this | Live |