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#

WherePartWhat it doesState
Player's PCLauncherServer list with live status, settings, joins a serverIn testing (no download yet)
Player's PCClientThe Alt:SA engine (Unity)Live
Player's PCGTA SA filesYour own copyRequired
Server hostDedicated serverThe same engine, headless, with a status endpointIn testing (no download yet)
Server hostGamemodeA C# plugin, e.g. Hello-Godfather (NG-RP next)In testing
Server hostGodfather-APIPlayers, camera, UI kit, storage, accounts (v0.2)In testing
Server hostStorageSQLite on the host (data/godfather/godfather.db), accounts with salted slow hashesIn testing
Server hostGTA SA filesThe host's own copyRequired

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#

  1. You pick a server in the launcher. The launcher asks each listed server for its name, players and gamemode.
  2. The client starts and connects. It loads your GTA SA files, then joins the server over the network.
  3. 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.
  4. 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.

RepositoryWhatState
Alt-SAMP/EngineThe Unity engine: client and dedicated serverLive
Alt-SAMP/BrandLogos, icons and design tokensLive
Alt-SAMP/WebsiteThis site and wikiLive
Alt-SAMP/Godfather-APIGamemode API and its docsv0.2
Knot-Vector/NG-RPThe first community: gamemode and sitePlanned
Knot-Vector/Agent-ToolkitSkills and tools for the agents building all of thisLive