mirror of
https://github.com/Michatec/wk_wars2x.git
synced 2026-04-01 00:16:27 +02:00
docs: update config section of README.md
This commit is contained in:
34
README.md
34
README.md
@@ -27,13 +27,29 @@ All of the configuration for the Wraith ARS 2X is done inside the `config.lua` f
|
||||
-- Radar fast limit locking
|
||||
-- When enabled, the player will be able to define a fast limit within the radar's menu, when a vehicle
|
||||
-- exceeds the fast limit, it will be locked into the fast box. Default setting is disabled to maintain realism
|
||||
CONFIG.allow_fast_limit = false
|
||||
CONFIG.allow_fast_limit = true
|
||||
|
||||
-- Radar only lock players with auto fast locking
|
||||
-- When enabled, the radar will only automatically lock a speed if the caught vehicle has a real player in it.
|
||||
CONFIG.only_lock_players = false
|
||||
|
||||
-- In-game first time quick start video
|
||||
-- When enabled, the player will be asked if they'd like to view the quick start video the first time they
|
||||
-- open the remote.
|
||||
CONFIG.allow_quick_start_video = true
|
||||
|
||||
-- Allow passenger view
|
||||
-- When enabled, the front seat passenger will be able to view the radar and plate reader from their end.
|
||||
CONFIG.allow_passenger_view = true
|
||||
|
||||
-- Allow passenger control
|
||||
-- Dependent on CONFIG.allow_passenger_view. When enabled, the front seat passenger will be able to open the
|
||||
-- radar remote and control the radar and plate reader for themself and the driver.
|
||||
CONFIG.allow_passenger_control = true
|
||||
|
||||
-- Set this to true if you use Sonoran CAD with the WraithV2 plugin
|
||||
CONFIG.use_sonorancad = false
|
||||
|
||||
-- Sets the defaults of all keybinds
|
||||
-- These keybinds can be changed by each person in their GTA Settings->Keybinds->FiveM
|
||||
CONFIG.keyDefaults =
|
||||
@@ -84,7 +100,15 @@ CONFIG.menuDefaults =
|
||||
|
||||
-- The speed unit used in conversions
|
||||
-- Options: mph or kmh
|
||||
["speedType"] = "mph"
|
||||
["speedType"] = "mph",
|
||||
|
||||
-- The state for automatic speed locking. This requires CONFIG.allow_fast_limit to be true.
|
||||
-- Options: true or false
|
||||
["fastLock"] = false,
|
||||
|
||||
-- The speed limit required for automatic speed locking. This requires CONFIG.allow_fast_limit to be true.
|
||||
-- Options: 0 to 200
|
||||
["fastLimit"] = 60
|
||||
}
|
||||
|
||||
-- Here you can change the default scale of the UI elements, as well as the safezone size
|
||||
@@ -94,9 +118,9 @@ CONFIG.uiDefaults =
|
||||
-- Options: 0.25 - 2.5
|
||||
scale =
|
||||
{
|
||||
radar = 1.0,
|
||||
remote = 1.0,
|
||||
plateReader = 1.0
|
||||
radar = 0.75,
|
||||
remote = 0.75,
|
||||
plateReader = 0.75
|
||||
},
|
||||
|
||||
-- The safezone size, must be a multiple of 5.
|
||||
|
||||
Reference in New Issue
Block a user