Godfather-API roadmap

The C# API every Alt:SA gamemode is written against: server lifecycle, players, storage, messages, and the black-glass UI kit drawn on players' screens. Small, stable and versioned, so gamemodes keep working as the engine changes.

  1. Done

    Design

    4/4

    The v0.1 surface and the UI kit look are agreed before any code is written.

  2. Done

    v0.1: first gamemodes

    6/6

    A gamemode DLL loads on the dedicated server, reacts to players joining, shows UI and stores data.

    • Gamemode lifecycle: OnServerStart, OnPlayerJoined, OnPlayerLeftAlt-SAMP/Engine#10tests/Godfather.Tests 9/9
      Done
    • Players: name, position, spawn, freeze, toast, chat, kickAlt-SAMP/Engine#10engine autotest godfather: spawn, freeze, toast
      Done
    • Storage: player, server and named buckets as JSON filesAlt-SAMP/Engine#10visits persisted across two server runs (Visit 1, then Visit 2)
      Done
    • UI kit: panel, text and password fields, buttons, toast (server-driven)Alt-SAMP/Engine#10engine Build/Alt-SA/autotest/godfather_01_panel.png
      Done
    • Hello-Godfather example gamemodeexamples/HelloGodfather
      Done
    • Self-test: the example loads on a dedicated server and its UI shows on a clientAlt-SAMP/Engine#10Tools/run-autotest.sh godfather 17/17 on a dedicated server
      Done
  3. Done

    v0.2: sign-in support

    3/3

    Everything the NG-RP sign-in needs.

    • Camera: fly-over, fly-to and followAlt-SAMP/Engine#11engine autotest ngrp: fly-over 210 m up and moving; fly-to the saved position
      Done
    • Accounts: salted slow hashes, rate-limited attemptsAlt-SAMP/Engine#11PBKDF2 test vectors, lock after 5 tries (Godfather tests 15/15); ngrp wrong password rejected with tries left
      Done
    • SQLite storage backendAlt-SAMP/Engine#11SQLite file test (no plain-text password); ngrp database holds the account and saved position
      Done
  4. Planned

    Growing the API

    2/6

    Reference list of what comes after v0.1.

    • Vehicles: spawn, owners, locks, engine
      Planned
    • HUD hooks: money, strips, timers, GPS waypoint, hiding pieces, wanted levelAlt-SAMP/Engine#13engine huddemo 19/19: stars clear 6.0 s after leaving the search area; Godfather tests 19/19
      Done
    • Menus, HUD stat lines and custom sights per weapon (v0.4)Alt-SAMP/Engine#14engine huddemo 30/30: menu keys, Enter, Backspace, stats, sight; Godfather tests 23/23
      Done
    • Chat commands and permissions
      Planned
    • Lua scripting layer on top of the C# API
      Planned
    • Gamemode packages and a registry
      Planned