Faction

Factions you set up entirely in game: every faction is a real job with boss menu, garages, storages, wardrobe, elevator, level, action menu and gang war system. The script creates the tables itself.

Features

• Creator (/fraktionen): Create factions in game with ranks, salary, vehicles, locations (marker or NPC), blips and access from a certain rank.
• Boss menu: Manage members, treasury with history, buy vehicles, permissions per rank, applications and logs.
• Applications: Players apply to factions at application spots (NPC or marker from the creator), the leadership accepts or rejects in the boss menu.
• GPS: Members see each other on the map, with their own icon on foot, in a car, on a motorcycle or bicycle, in a boat, helicopter or plane, while swimming and when dead (on/off per faction).
• Faction vehicles with style: own plate prefix, paint and xenon in the faction color, max tuning and tinted windows. With a key to lock and unlock.
• Garages and storages: up to 10 each per faction, access from a certain rank.
• Wardrobe, elevator (up to 10 floors) and level with XP (on/off per faction).
• Action menu (F6): Cuff, search, identify, escort and vehicle actions, selectable per faction.
• Gang war: Create zones in game, modes Time limit and First Contact, own dimension, shop and leaderboard.
• Discord logs for all areas.

Installation

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

ensure oxmysql
ensure es_extended
ensure off_faction

1. Open /fraktionen, create a faction and set the leadership with /setjob <ID> <name> <rank> (highest rank = number of ranks − 1).

Configuration

config/settings/config.lua

config/settings/config.gangwar.lua

config/settings/config.actions.lua

config/functions.lua

This is where you hook up your own scripts. Errors in it end up in the console, the script keeps running.

config/settings/config.server.lua and languages

Discord webhooks per area (creator, members, money, garage, storage, wardrobe, level, gangwar, actions), url = '' turns a log off. All texts are in config/locales/ (one file per language).

In game

• Creator (/fraktionen): Create a faction, set locations with Use my position, markers, NPCs and blips via Customize, under Settings turn on the level system, garage, storage, gang war and the F6 menu actions. Only Save applies everything. At the top you switch to Applications and Gang war zones.
• Adjust NPC: Pick a model from an image list of all GTA peds (search and categories), plus scenario and heading, all with live preview in game. You pick an addon ped by typing the exact model name into the search.
• Vehicle style (Creator → Vehicles): Plate prefix with up to 5 characters, e.g. BALLA gives BALLA 48. If the prefix changes, all faction vehicles get a new plate when you save and vehicles that are out are removed. Plus paint in the faction color, max tuning, tinted windows and xenon in the faction color.
• GPS (Creator → Settings): Members see each other on the map. The icon changes depending on the state, colors and icons are in gps.types. The blip only shows the heading on foot and while swimming, vehicle icons always stay upright.
• Keys: Whoever takes out a faction vehicle can lock and unlock it with U (changeable in the FiveM key bindings). With vehicleKeys.shared = true all members can do that.
• Applications: You create application spots in the creator under Applications (up to 20), as NPC or marker and optionally with a blip for all players. They apply to all factions. At the spot, E opens the list of all factions that accept applications, there you send a text. Your own faction isn't in the list. Members with the permission Invite members get a message and see the application in the boss menu under Members → Applications. You can also close applications there. Accepting also works when the player is offline.
• Logs (boss menu, bottom button): everything that happens in the faction, e.g. deposits and withdrawals, vehicles taken out, stored or bought, storage, wardrobe, members, applications, gang war shop and level. Gang war attacks aren't listed there. Visible to the leadership and ranks with the permission View logs.
• Locations: At the boss menu, garage, storage, wardrobe and elevator, E opens the menu.
• Action menu (F6): Works on the player or vehicle directly in front of you.
• Hard cuffs: only look around. Soft cuffs: walk, but not sprint, jump or attack. Select again to remove them.
• Search: only cuffed players, you can only take things.
• Escort: lead a cuffed player in front of you. Put in vehicle / Take out of vehicle for cuffed players.
• Vehicle: wash, repair, impound (private vehicles end up in the off_garage impound) and identify. X cancels.
• Gang war: At the gang war point, E opens the menu. One faction queues a zone, another one accepts. Join with E at the gang war point.
• Time limit: starts right away, points per kill, respawn, joining possible until the end.
• First Contact: join time in the lobby, then one life per player.

For developers

exports.off_faction:AddXP('vagos', 250)
exports.off_faction:SetLevel('vagos', 5, 0)
local level, xp, needXp = exports.off_faction:GetLevel('vagos')
local faction = exports.off_faction:GetFaction('vagos')
local list = exports.off_faction:GetFactions()
local isFaction = exports.off_faction:IsFaction('vagos')
local name, grade = exports.off_faction:GetPlayerFaction(source)
local allowed = exports.off_faction:HasPermission(source, 'withdraw')
exports.off_faction:AddBalance('vagos', 5000, 'Reward')
exports.off_faction:RemoveBalance('vagos', 5000, 'Strafe')

• All exports are server-side.
• Server event off_faction:levelUp with (faction, level) on level up.
• Statebags: offGangwar (zone ID in the gang war), offCuffed ('hard', 'soft' or false), offEscorted (server ID of the escorting player).

Common issues

On start, the script reports errors and hints in the server console.