FAXES Documentation > FiveM Documentation > Area of Patrol (AOP) Installation

Area of Patrol (AOP) Installation

FAXES
  • Install the base resource like any other resource. Otherwise known as the drag and drop method.

  • Open the config.lua file and change the settings to your liking. See the Variable Documentation to see what these are and do.

  • If you have usingPerms set to true (usingPerms = true) you will need to set up a method for permissions and a way to authenticate users when they perform actions to interact with Fax-AOP. You have an option to either use the hexadecimal method or Discord ID method.

Steam Hexadecimal Method: Simply copy and paste the below into your server.cfg and replace the HEX_ID_HERE with your steam hexadecimal. If you're unsure on how yo get your hexadecimal see How to get your Steam hexadecimal.

add_ace Fax.AOP faxes.aopcmds allow
add_principal identifier.steam:ID_HERE Fax.AOP

Discord ID Method: Make sure you have installed discordroles and have it working correctly. Once you have done this put a role ID into the discordRoleNames config value. Once this is done set usingDiscordPerms to true to enable. See the installation guide for this.

All done!


Variable Documentation

Below you will find what each configuration option is and what it does, it's default value and other information.

1. General Config & Commands

Variable Name Description Default Value
FaxCurAOP The default AOP that is used when the script is (re)started. "None Set"
usingPerms Toggles ACE permission use. For no command permissions set to false. true
vote Toggles AOP vote commands. true
AOPChangeNotification Toggles a native display when the AOP is changed. https://faxes.zone/img/01ded.png true
AOPCommand String to edit the set aop command. "aop"
PTCommand String to edit the peacetime toggle command. "pt"
AOPVoteCommand String to change the start AOP vote command. "aopvote"
featColor Colours used in highlighting for the draw-text. Available colours: https://gist.github.com/leonardosnt/061e691a1c6c0597d633 ~p~
noPermsMessage Notification message given if the player does not have permissions. "~r~Insufficient Permissions."

2. Peacetime Settings

Variable Name Description Default Value
peacetime Enables the peacetime function. true
peacetimeNS Enables no shooting when peacetime is active. true
maxPTSpeed Max Speed people can go during peacetime before getting notified to slow down (in mph). 100
PTOnMessage Message displayed when peacetime is turned on. featColor .. "Peace Time ~w~is now ~g~ in effect!"
PTOffMessage Message displayed when peacetime is turned off. featColor .. "Peace Time ~w~is now ~r~off."

3. DrawText Settings

Varible Name Description Default Value
AOPLocation 0 = Default, 1 = bottom center, 2 = bottom right, 3 = top right, 4 = top center, 5 = top left, 6 = custom setting (x, y) NOTE! 2 & 3 are not set up and will display as the default! 0
serverPLD Server-side PLD installed? Only set to true if using the default AOPLocation. false
localTime 0 = off, 1 = client local time, 2 = game time 1
AOPx The x coordinate for custom AOPLocation (Only use if AOPLocation is set to 6). 0.660
AOPy The y coordinate for custom AOPLocation (Only use if AOPLocation is set to 6). 1.430

4. Auto AOP Settings

Variable Name Description Default Value
autoChangeAOP Would you like the AOP to change based on the amount of players? If true, see settings below! false
ACAOPUnder5 AOP Auto-set if there is under 5 players. "Paleto Bay"
ACAOPUnder10 AOP Auto-set if there is under 10 players. "Sandy Shores"
ACAOPUnder20 AOP Auto-set if there is under 20 players. "Blaine County"
ACAOPUnder30 AOP Auto-set if there is under 30 players. "Los Santos"
ACAOPOver30 AOP Auto-set if there is over 30 players. "San Andreas"

5. AOP Spawn Locations

Variable Name Description Default Value
AOPSpawnsEnabled Enables AOP based spawn points. See example below. false
AOPSpawns Table that stores area names and their spawn points See below example

AOPSpawns Example:

AOPSpawns = {
	{
		AOPName =  'sandy shores',
		AOPCoords = {x =  311.22, y =  3457.60, z =  36.15}
	},
	{
		AOPName =  'paleto bay',
		AOPCoords = {x =  -447.24, y =  5970.46, z =  31.78}
	},
	{
		AOPName =  'downtown',
		AOPCoords = {x =  219.98, y =  -913.38, z =  30.69}
	},
	{
		AOPName =  'rockford hills',
		AOPCoords = {x =  -851.57, y =  -128.04, z =  37.62}
	},
}

6. Discord Permissions

Variable Name Description Default Value
usingDiscordPerms Do you wish to use a Discord role for permissions to change the AOP and Peacetime? Please note you must have discord_perms installed false
discordRoleIds If the above (usingDiscordPerms) is set to true, list the role IDs that you wish to use "39484474747447325"

Was this article helpful?

54 out of 99 found this helpful