config

General settings

Config.Tablet = Config.Tablet or {
    Open = {
        mode = 'item',
        command = 'hiracing',
        key = 'B',
        item = 'hitab',
        shouldHaveItemToAccessRaces = true,
    }
}

• mode - defines how players can access the racing UI. Options: command , item, or both.

• command - the command used to open the UI when mode is set to command or both. Set to false to disable.

• key - optional key mapping for opening the UI when mode is set to command or both. Set to false to disable.

• shouldHaveItemToAccessRaces - If set to true, access to race lobbies is restricted to players who have the defined item.

---

Config.Dev = {
    CheckpointDebug = false,
    CircuitRaceCheckpointDist = 150.0
}

• CheckpointDebug - enables checkpoint debugging. Should only be used in development environment.

• CircuitRaceCheckpointDist - minimum distance between the first and last checkpoints to automatically determine whether the track is a CIRCUIT or SPRINT.

---

Config.Race = {
    JoinRadius = 70.0,
    CountDown = 10,
    MinRacers = 2,
    DnfTime = 180,
    IdleTime = 60,
}

• JoinRadius - defines the radius (using lib.zones.sphere from ox_lib) in which players can join a hosted race.

• CountDown - default countdown time (in seconds) before a race begins. Configurable from the race setup screen.

• MinRacers - minimum number of players required to start a race (minimum: 1). This setting does not apply to time trial races, since they are always solo and can be hosted individually. DnfTime - default "Did Not Finish" timer (in seconds) that begins once the leader finishes the race. When the timer expires, the race ends automatically.

• IdleTime - idle timeout (in seconds). Automatically removes idle players from races. Set to 0 to disable, or to a high number if you wish to allow longer waiting times. This value should be higher than the CountDown to prevent players from being removed while waiting for the race to start (they get frozen).

---

Config.Queue = {
    MinPlayers = 2,
    MaxPlayers = 10,
    TickDelay = 60000,
    AcceptTime = 30000,
    TravelTime = 10 * 60000,
    MinRacersToStart = 2,
}

• MinPlayers - minimum number of players required in the queue to create a race session.

• MaxPlayers - maximum number of players allowed in a single session. Any additional players in the queue will be placed in a separate session.

• TickDelay - interval (in milliseconds) at which the queue checks whether enough players are available to create a session.

• AcceptTime - time limit (in milliseconds) for players in the queue to accept or decline the race invitation. If enough players accept within this period, the session is created.

• TravelTime - time (in minutes x milliseconds) that players have to travel to the race start point and mark themselves as ready. The race will start automatically when the timer expires, unless all players mark themselves as ready earlier.

• MinRacersToStart - minimum number of ready players required for the race to begin once TravelTime has elapsed.

---

Config.FlagProp {
    -- do not edit
}

Do not edit. The flag prop setup is predefined to work with the racing system. Adding or replacing it with random props will not function correctly without custom adjustments.

---

Config.RaceFlags {
    state = {
        current,
        next,
        passed
    }
}

Defines the checkpoint states and their corresponding flag colors:

• current - the checkpoint the player is currently at. next - the upcoming checkpoint. passed - all other checkpoints (cleared or further than next).

You can view the full list of available colors for the prop in Flag Prop.