PVP

PvP system with FFA zones, Only zones and lobby matches in teams. Every zone and every match runs in its own dimension. On top of that there's a leaderboard and a match display. The script creates the table itself.

Features

• FFA zones: Everyone against everyone. Per zone fixed weapons or the player's own weapons. Respawn with armor and short spawn protection.
• Only zones: Everyone has the same weapons, optionally with a vehicle (e.g. BF 400) on every spawn.
• Lobbies: Team A vs. Team B in best-of mode with a decider round. Map, mode (on foot or vehicle), rounds, up to 3 weapons and an optional password can be chosen. The owner can kick, shuffle and disband.
• Spectating: Whoever is eliminated in a round watches the living teammates and switches with ← →.
• Match display at the top center and Leaderboard with the filters FFA, Only and Lobby (including wins and losses).
• Weapon protection: Fixed weapons only exist in PvP. The real weapons and their ammo stay protected.
• Discord logs, exports and your own functions to connect other scripts.

Installation

1. Put the off_pvp folder into your resources folder.
2. Add to your server.cfg, after oxmysql and ESX:

ensure oxmysql
ensure es_extended
ensure off_pvp

1. Adjust PvP points, zones and maps in config/ to your server.

The off_pvp_stats table is created automatically on the first start.

Configuration

The settings are in config/settings/: config.lua for everything general, config.ffa.lua, config.only.lua and config.lobby.lua for the three modes.

config/settings/config.lua

PvP points (points):

config/settings/config.ffa.lua and config/settings/config.only.lua

Config.ffa and Config.only contain the zones. Each zone has:

config/settings/config.lobby.lua

Config.lobby contains the settings for lobbies:

Config.maps contains the maps for lobbies:

config/functions.lua

This is where you hook up your own scripts. Errors in it end up in the console, the script keeps running. kind is always 'ffa', 'only' or 'lobby'.

config/settings/config.server.lua and languages

Discord webhooks for lobby (lobby created, match started, match ended, lobby disbanded) and zones (zone entered and left). '' turns a log off. All texts are in config/locales/ (one file per language).

In game

• Menu: E at a PvP point. This only works while you're alive, on foot, in the normal dimension and not in a gang war.
• FFA and Only: Join teleports you into the zone. After death you continue at a spawn after respawn.seconds. At the top you see kills, deaths and the players in the zone.
• Leaving: /quitffa (or your quitCommand) takes you back to the place where you joined. Health and armor are like before, your own weapons come back. The command also leaves a waiting lobby.
• Create lobby: Pick map, mode, rounds, weapons and optionally a password. New players go into the smaller team. Switching works as long as the other team isn't full. After 5 wrong passwords the lobby is locked for you for 60 seconds.
• Owner: starts, shuffles, kicks and disbands. If the owner leaves, the next member takes over.
• Start: Whoever is dead, in another dimension, in a gang war or farther than startRange from a PvP point gets removed from the lobby. Each team needs at least one player.
• Match:
• Each round starts with the preparation (frozen, no weapons), after that you get weapons and armor.
• A round is won by taking out the whole enemy team. There's no respawn within a round. If the last two die at the same time, nobody gets a point.
• If the time limit runs out, the team with more living players wins, on a tie nobody gets a point.
• The match is won by whoever first takes more than half of the rounds. Once all rounds are played, the higher score wins. On a tie there are decider rounds (overtimeRounds), then a draw.
• Friendly fire is on. A teamkill counts as a death, not as a kill.
• Whoever leaves a running match gets a loss. If a team is empty after that, the other one wins immediately.
• After that everyone returns to their starting point, the lobby stays open and waits again.
• Spectating: After spectateDelay seconds you watch a living teammate. Their name and the arrows are shown at the bottom center. ← and → switch.
• Garage (vehicle maps): During the round, E at your team's garage marker opens the vehicle list. Each player has one vehicle, a new one replaces the old one.
• Leaderboard: The best players per mode (number via leaderboardSize), sorted by kills. New values show up within a minute at the latest, right away after a match.

For developers

-- Server
local inPvp = exports.off_pvp:IsInPvp(source)        -- FFA, Only or running match
local ffa = exports.off_pvp:IsFFA(source)
local only = exports.off_pvp:IsOnly(source)
local lobby = exports.off_pvp:IsLobby(source)        -- in a running match
local inLobby = exports.off_pvp:IsInLobby(source)    -- member of a lobby, waiting or in a match
local info = exports.off_pvp:GetPvp(source)          -- { kind, id, team, alive, kills, deaths } or nil
local removed = exports.off_pvp:RemoveFromPvp(source) -- takes the player out of a zone, match or waiting lobby, true/false
local stats = exports.off_pvp:GetStats(source)       -- { ffa = { kills, deaths }, only = { ... }, lobby = { kills, deaths, wins, losses } } or nil

-- Client
local inPvp = exports.off_pvp:IsInPvp()
local ffa = exports.off_pvp:IsFFA()
local only = exports.off_pvp:IsOnly()
local lobby = exports.off_pvp:IsLobby()
local spectating = exports.off_pvp:IsSpectating()
local info = exports.off_pvp:GetPvp()                -- { kind, id, team, phase } or nil

• Statebag offPvp: 'ffa', 'only' or 'lobby' while the player is in a zone or a match.
• offinventory: canOpen() in off_inventory/config/functions.lua blocks the inventory and trunk in PvP as soon as offpvp is running.

Common issues

On start, the script reports errors and hints in the server console. Faulty zones and maps are listed there and ignored.