Systems Overview

Architecture, config overview, free-roam systems, and open edit hooks

Architecture

Key files:

  • shared/config.lua holds game modes, maps, free-roam settings, zones, HUD, rewards, leaderboards, language keys, and arcade settings.

  • shared/lang.lua and shared tables hold strings and helper data.

  • server/server_edit.lua holds webhook URLs, game lifecycle hooks, weather integration, and server-side zombify protection.

  • client/client_edit.lua holds HUD integration, fuel helpers, text UI, notifications, announcements, and client exports.

  • server/server_admin.lua and client/admin.lua wire admin commands and the admin menu.

  • server/server_leaderboards.lua and data/leaderboards.json handle stored leaderboard data.

  • client/client_scoreboard.lua handles the in-game scoreboard keybind flow.

  • web/ contains the lobby and UI build.

Other escrow files handle the actual gameplay, spawning, modes, and NUI actions.

Config overview

Important areas:

  • Config.Debug

  • Config.Target

  • Config.AdminRole

  • Config.AdminMenuCommand

  • Config.PlayersCanDenyAdminGame

  • Config.AdminGameInviteTimeout

  • Config.GameModes

  • Config.FreeRoamZombies

  • Config.OnFootZombiesOnly

  • Config.SpawnExtraZombies

  • Config.SafeZones

  • Config.DangerZones

  • Config.Sprinters

  • Config.FreeRoamSpecialZombies

  • Config.ArcadeLocations

  • Config.ZombieGamesCommand

  • Config.HUD

  • Config.ArcadeRewards

  • Config.Leaderboards

Free-roam systems

Free-roam zombies are separate from the arcade game modes.

Main free-roam systems include:

  • world zombie conversion

  • safe zones

  • danger zones

  • extra spawn helpers when density is low

  • sprinters and special zombie behavior

Danger zones can still spawn extra zombies even if free-roam zombies are otherwise disabled, depending on the zone settings.

Open files and hooks

Server hooks

Common open server hooks include:

  • DiscordWebhooks

  • WeatherAndTime()

  • OnGameStarted

  • OnGameEnded

  • GameStartedForPlayer

  • GameEndedForPlayer

  • DoNotZombify

  • AllowZombify

Client hooks

Common open client hooks include:

  • HideHUD

  • ShowHUD

  • SetFuel

  • ShowTextUI

  • HideTextUI

  • Notification

  • Announce

  • ClearAnnouncements

These are the main integration points for HUD, fuel, notifications, weather, and mission-ped protection.

Last updated