Dev Mode

You can enable/disable dev mode. It will generate some print info within console. Never should have this enabled in a live server

EnableDev = false, -- Enable/Disable DevMode

Locale

You can change the language of the notifications and other plain text elements of this resource.

Note: English is provided and it can be translated to anything that you wish.

Locale = 'en', -- Locale to use

Resources

This is where you can make adjustments just as a custom vorp_menu resource name, selected character event (server side), as well as adjusting the menu position

VorpMenu = 'vorp_menu',                                         -- Vorp Menu resource name
VorpMenuPosition = 'top',                                       -- Menu position (left, top-left, top, right, top-right, bottom-right, bottom, bottom-left)
SelectedCharacterEvent = 'vorp:SelectedCharacter',              -- Server side event triggered when character is selected

Prop

You can change the flag prop to any prop you'd like as long as it exists in game. You can also adjust the distance that it spawns.

UIPrompt / Keybind

You can enable/disable UIPrompts (will use DrawText instead). You can also change the key required to interact.

Peds

These are the settings for unclaimed zones. If enabled, peds will spawn to protect unclaimed zones when a player attempts to claim the zone. You can control the random weapons they will spawn with, the ped model, the total peds to spawn and the amount max alive.

Blip

This is displayed at the flag location. You can disable but I highly recommend keeping enabled. It will flash when a zone is being disputed.

TxAdmin

Enable/Disable TxAdsmin integration. This will disable the ability to declare new wars before server restarts.

Timers

Adjust various timers.

  • claim: The amount of time it takes to claim the zone

  • upkeep: The amount of time a zone remains inactive before it is set to unclaimed

  • war: The amount of time after a declaration of war before peace can be declared

Requirements / Restrictions

You can adjust the required members to be inside of the claim radius and alive to keep the claim active. Otherwise it is reset. You can also enable/disable whether or not a player can declare war on a gang while being in their zone (I recommend keeping this false).

Default Zone Color

This is the default color used for unclaimed zones. You can find all of the "blip_modifier_mp_color" examples here.

Zones

This is where you will configure the zones.

  • enable: Enable/Disable this zone

  • label: The label text for this zone

  • claim: The location (vec3) where the flag will be spawned.

  • claimDistance: This is the radius which players are registered as "inside" while claiming


Full Configuration

This is already included in the resource. Use this as a backup or an example

Last updated