Michatec/wk_wars2x
1
1
Fork 0
mirror of https://github.com/Michatec/wk_wars2x.git synced 2026-04-01 08:26:27 +02:00
Code Issues Packages Projects Releases Activity

Updated README.md

Browse Source
This commit is contained in:
Dan
2020-03-28 17:56:37 +00:00
parent bcb772514f
commit 02ad05639e
1 changed files with 22 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
README.md
View File

@@ -11,16 +11,15 @@ It's now installed! When you boot your server you should see a Wraith ARS 2X mes
## Default key binds
Although these can be viewed ingame through the operator manual, the default key binds are listed below.
| Action | Key | Description |
| ------------------------- | --------------------------- | ----------- |
| Open remote | F5 | Opens the remote control, this only works if you are the driver of a police vehicle (must have the vehicle class VC_EMERGENCY). |
| Close remote | ESC or right mouse button | Closes the remote/all of the displayed UI elements, and returns focus to the game. |
| Lock/unlock front antenna | Numpad 8 (full) / 1 (small) | Locks the current speed of the front antenna. If there is a fast speed displayed, the system will lock the fast speed. Otherwise it will lock the strong speed. When you lock a speed, the radar will audibly tell you which antenna is being locked, and the relative direction of the target compared to the patrol vehicle (e.g. "Front Closing"). |
| Lock/unlock rear antenna | Numpad 5 (full) / 2 (small) | Locks the current speed of the rear antenna. If there is a fast speed displayed, the system will lock the fast speed. Otherwise it will lock the strong speed. When you lock a speed, the radar will audibly tell you which antenna is being locked, and the relative direction of the target compared to the patrol vehicle (e.g. "Rear Away"). |
| Lock/unlock front plate | Numpad 9 (full) / 3 (small) | Locks the plate currently caught by the front plate reader, an audible beep will also be heard unless the plate reader audio option in the operator menu is changed. |
| Lock/unlock rear plate | Numpad 6 (full) / 4 (small) | Locks the plate currently caught by the rear plate reader, an audible beep will also be heard unless the plate reader audio option in the operator menu is changed. |
| Toggle keylock | L | Toggles the keylock state. When enabled, none of the keybinds will work until keylock is toggled again. |
| Toggle keybind set | K | Toggles between the full and small keybind sets for locking/unlocking the radar/plate reader. |
| Action | Key | Description |
| ------------------------- | ------------------------- | ----------- |
| Open remote | F5 | Opens the remote control, this only works if you are the driver of a police vehicle (must have the vehicle class VC_EMERGENCY). |
| Close remote | ESC or right mouse button | Closes the remote/all of the displayed UI elements, and returns focus to the game. |
| Lock/unlock front antenna | Numpad 8 | Locks the current speed of the front antenna. If there is a fast speed displayed, the system will lock the fast speed. Otherwise it will lock the strong speed. When you lock a speed, the radar will audibly tell you which antenna is being locked, and the relative direction of the target compared to the patrol vehicle (e.g. "Front Closing"). |
| Lock/unlock rear antenna | Numpad 5 | Locks the current speed of the rear antenna. If there is a fast speed displayed, the system will lock the fast speed. Otherwise it will lock the strong speed. When you lock a speed, the radar will audibly tell you which antenna is being locked, and the relative direction of the target compared to the patrol vehicle (e.g. "Rear Away"). |
| Lock/unlock front plate | Numpad 9 | Locks the plate currently caught by the front plate reader, an audible beep will also be heard unless the plate reader audio option in the operator menu is changed. |
| Lock/unlock rear plate | Numpad 6 | Locks the plate currently caught by the rear plate reader, an audible beep will also be heard unless the plate reader audio option in the operator menu is changed. |
| Toggle keylock | L | Toggles the keylock state. When enabled, none of the keybinds will work until keylock is toggled again. |
## Script configuration
All of the configuration for the Wraith ARS 2X is done inside the `config.lua` file, below is a copy of the configuration file. All of the options have comments to describe what they do, along with the available options you can set. You have the ability to change the key binds for the large and small key set, the default operator menu options, and the default UI element scale and safezone.
@@ -35,58 +34,27 @@ CONFIG.allow_fast_limit = false
-- open the remote.
CONFIG.allow_quick_start_video = true
-- Sets all of the controls
CONFIG.keys =
-- Sets the defaults of all keybinds
-- These keybinds can be changed by each person in their GTA Settings->Keybinds->FiveM
CONFIG.keyDefaults =
{
-- Remote control key
-- The default key to open the remote control is 166 (F5 - INPUT_SELECT_CHARACTER_MICHAEL)
remote_control = 166,
remote_control = "f5",
-- Radar key lock key
-- The default key to enable/disable the radar key lock is 182 (L - INPUT_CELLPHONE_CAMERA_FOCUS_LOCK)
key_lock = 182,
key_lock = "l",
-- Radar keybinds switch
-- The default key to switch the bind set is (K - INPUT_REPLAY_SHOWHOTKEY)
switch_keys = 311,
-- Radar front antenna lock/unlock Key
front_lock = "numpad8",
-- Keys for a full size keyboard
[ "full" ] = {
-- Radar front antenna lock/unlock Key
-- The default full keyboard key to lock/unlock the front antenna is 111 (Numpad 8 - INPUT_VEH_FLY_PITCH_UP_ONLY)
front_lock = 111,
-- Radar rear antenna lock/unlock Key
rear_lock = "numpad5",
-- Radar rear antenna lock/unlock Key
-- The default full keyboard key to lock/unlock the rear antenna is 112 (Numpad 5 - INPUT_VEH_FLY_PITCH_DOWN_ONLY)
rear_lock = 112,
-- Plate reader front lock/unlock Key
plate_front_lock = "numpad9",
-- Plate reader front lock/unlock Key
-- The default full keyboard key to lock/unlock the front plate reader is 118 (Numpad 9 - INPUT_VEH_FLY_SELECT_TARGET_RIGHT)
plate_front_lock = 118,
-- Plate reader rear lock/unlock Key
-- The default full keyboard key to lock/unlock the rear plate reader is 109 (Numpad 6 - INPUT_VEH_FLY_ROLL_RIGHT_ONLY)
plate_rear_lock = 109
},
-- Keys for smaller keyboards
[ "small" ] = {
-- Radar front antenna lock/unlock Key
-- The default small keyboard key to lock/unlock the front antenna is 157 (1 - INPUT_SELECT_WEAPON_UNARMED)
front_lock = 157,
-- Radar rear antenna lock/unlock Key
-- The default small keyboard key to lock/unlock the rear antenna is 158 (2 - INPUT_SELECT_WEAPON_MELEE)
rear_lock = 158,
-- Plate reader front lock/unlock Key
-- The default small keyboard key to lock/unlock the front plate reader is 160 (3 - INPUT_SELECT_WEAPON_SHOTGUN)
plate_front_lock = 160,
-- Plate reader rear lock/unlock Key
-- The default small keyboard key to lock/unlock the rear plate reader is 164 (4 - INPUT_SELECT_WEAPON_HEAVY)
plate_rear_lock = 164
}
-- Plate reader rear lock/unlock Key
plate_rear_lock = "numpad6"
}
-- Here you can change the default values for the operator menu, do note, if any of these values are not