You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/radio/config.mdx
+38-64
Original file line number
Diff line number
Diff line change
@@ -3,81 +3,48 @@
3
3
Here you can find detailed description of each config option.
4
4
Options marked with ✏ symbol automatically overrides the pma-voice convars.
5
5
6
-
## locale
7
-
What supported language to use for notifications and UI.
8
-
Locale name is the same as the file name in [locales](https://github.com/acscripts/ac_radio/tree/main/locales) folder without the `.lua` extension (eg. **en**, **cs**).
9
-
Note that some character sets may not be supported when using the default notifications (eg. `ěčřůďťň`).
10
-
Feel free to submit a PR with more languages!
11
-
12
-
**Accepted values**
13
-
`'en'` = Or any other locale.
14
-
15
6
16
7
17
-
## versionCheck
18
-
Whether to check for newer resource version and notify in server console.
8
+
## useUsableItem
9
+
Whether to allow opening the radio UI using an inventory item.
10
+
Following the [Installation guide](./install.mdx) is recommended before enabling this option.
19
11
20
12
**Accepted values**
21
-
`true` = You will be notified in server console when a newer version of **ac_radio** is available.
22
-
`false` = You will need to manually check for a newer version on GitHub 👎🏽
23
-
24
-
25
-
26
-
## useCustomNotify
27
-
Whether to use custom notification function located in [utils.lua](https://github.com/acscripts/ac_radio/tree/main/resource/client/utils.lua) in `customNotify`.
28
-
If you have [ox_lib](https://github.com/overextended/ox_lib) resource running, you can set this to `true` and not worry about anything else.
29
-
Otherwise, you must add your own notification code snippet to the **customNotify** function.
30
-
31
-
**Accepted values**
32
-
`true` = The code inside `customNotify` function will be used instead of the default notification.
33
-
`false` = The default GTA V notifications will be used.
13
+
`boolean` (true / false)
34
14
35
15
36
16
37
17
## useCommand
38
-
Whether to use command for opening the radio UI.
18
+
Whether to allow opening the radio UI using a command.
39
19
40
20
**Accepted values**
41
-
`true` = A command to open the radio will be created.
42
-
`false` = It will only be possible to open the radio UI using an item (if you're using one of the supported frameworks) or using the following snippets.
43
-
44
-
**Snippets**
45
-
```lua copy filename="Your own script"
46
-
-- Export
47
-
exports.ac_radio:openRadio()
48
-
49
-
-- Event
50
-
TriggerEvent('ac_radio:openRadio')
51
-
TriggerClientEvent('ac_radio:openRadio', source)
52
-
```
21
+
`boolean` (true / false)
53
22
54
23
55
24
56
25
## commandKey
57
26
Default keybind for the radio command. Use only if the option above (**useCommand**) is set to `true`.
58
27
59
28
**Accepted values**
60
-
`false` = The keybind will not be created at all.
29
+
`false` = Keybind will not be created at all.
61
30
`''` = Empty quotes for creating the keybind, but not setting a default key.
62
31
`'NUMPAD0'` = Or any other [valid key](https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard) to create a keybind with **this** default key.
63
32
64
33
65
34
66
-
## noRadioDisconnect
67
-
Whether to disconnect from radio when there is no radio item in player's inventory.
35
+
## disconnectWithoutRadio
36
+
Whether to disconnect player from frequency when there is no radio item left in player's inventory.
68
37
69
38
**Accepted values**
70
-
`true` = You will be disconnected from radio when there is no radio item in your inventory.
71
-
`false` = You won't.
39
+
`boolean` (true / false)
72
40
73
41
74
42
75
-
## maximumFrequencies
76
-
Maximum number of available channel frequencies.
77
-
Frequency range will be **from more than 0 to this value inclusive**.
43
+
## volumeStep
44
+
Percentage of volume to increase/decrease per step.
78
45
79
46
**Accepted values**
80
-
`number` = Self explanatory.
47
+
`number`
81
48
82
49
83
50
@@ -86,30 +53,39 @@ How much the frequency value can change per step.
86
53
If set to `0.01`, available frequencies will be **32.56**, **32.57**, **32.58** etc. Can be an integer as well.
87
54
88
55
**Accepted values**
89
-
`number` = Self explanatory.
56
+
`number`
57
+
58
+
59
+
60
+
## maximumFrequencies
61
+
Maximum amount of available frequencies.
62
+
Frequency range will be **from more than 0 to this value inclusive**.
63
+
64
+
**Accepted values**
65
+
`number`
90
66
91
67
92
68
93
69
## restrictedChannels
94
-
In the following text, the term "group" has the same meaning as "job".
95
-
Restricts certain channel frequencies for given groups and grades. Each specific frequency must be listed separately.
70
+
Restricts certain frequencies for given groups and grades. Each frequency must be listed separately.
96
71
97
72
**Accepted values**
98
-
Table of any amount of frequencies
73
+
`table` as following:
74
+
99
75
```lua
100
76
-- Single group without grade (any grade in this group can access it)
101
77
[frequency] ='group'
102
78
103
79
-- Single group with grade
104
80
[frequency] = {
105
-
group=grade
81
+
group=grade,
106
82
}
107
83
108
84
-- Multiple groups
109
85
[frequency] = {
110
86
group1=grade1,
111
87
group2=grade2,
112
-
group3=grade3
88
+
group3=grade3,
113
89
}
114
90
```
115
91
@@ -119,39 +95,37 @@ restrictedChannels = {
119
95
[1] = {
120
96
police=5, -- "police" with grade >=5 can access 1 MHz
121
97
ambulance=7, -- "ambulance" with grade >=7 can access 1 MHz
122
-
fbi=0-- all of "fbi" can access 1 MHz
98
+
government=0,-- all of "government" can access 1 MHz
123
99
},
124
100
[1.1] ='police', -- all of "police" can access 1.1 MHz
125
101
[1.2] ='ambulance', -- all of "ambulance" can access 1.2 MHz
126
-
[1.3] ='fbi' -- all of "fbi" can access 1.3 MHz
102
+
[1.3] ='government' -- all of "government" can access 1.3 MHz
127
103
}
128
104
```
129
105
130
106
131
107
132
108
## radioEffect ✏
133
-
Whether to enable radio submix effect.
134
-
Overrides `voice_useNativeAudio` and `voice_enableSubmix` convars.
109
+
Whether to enable radio voice effect. Player voice will sound like on a real radio.
110
+
Overrides `voice_useNativeAudio` and `voice_enableSubmix` convars from pma-voice.
135
111
136
112
**Accepted values**
137
-
`true` = People on radio will sound like on real-life radio.
138
-
`false` = No additional voice submix will be applied.
113
+
`boolean` (true / false)
139
114
140
115
141
116
142
117
## radioAnimation ✏
143
118
Whether to enable animation while talking on radio.
144
-
Overrides `voice_enableRadioAnim` convar.
119
+
Overrides `voice_enableRadioAnim` convar from pma-voice.
145
120
146
121
**Accepted values**
147
-
`true` = Your hand will be placed on shoulder while talking on radio.
148
-
`false` = Nothing will happen.
122
+
`boolean` (true / false)
149
123
150
124
151
125
152
126
## radioKey ✏
153
-
Whether to enable animation while talking on radio.
154
-
Overrides `voice_defaultRadio` convar.
127
+
Default keybind for talking on the radio.
128
+
Overrides `voice_defaultRadio` convar from pma-voice.
155
129
156
130
**Accepted values**
157
-
`'LMENU'` = Or any other [valid key](https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard) to create a keybind with **this** default key.
Copy file name to clipboardExpand all lines: pages/radio/index.md
+3-5
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,9 @@
1
1
# Getting started
2
2
3
-
ac_radio is a framework-standalone user interface for radio control. The only dependency is[pma-voice](https://github.com/AvarianKnight/pma-voice)system.
3
+
ac_radio is a framework-standalone user interface for radio control. The only dependencies are[pma-voice](https://github.com/AvarianKnight/pma-voice)and [ox_lib](https://github.com/overextended/ox_lib).
4
4
5
-
You can use any supported framework to enable additional features such as usable item or restrictions. Supported frameworks are [ox_core](https://github.com/overextended/ox_core), [es_extended](https://github.com/esx-framework/esx-legacy) and [qb-core](https://github.com/qbcore-framework/qb-core).
5
+
You can use any supported framework to enable additional features such as usable item or restrictions.
6
+
Supported frameworks are [ox_core](https://github.com/overextended/ox_core), [qbx_core](https://github.com/Qbox-project/qbx_core), [qb-core](https://github.com/qbcore-framework/qb-core) and [es_extended](https://github.com/esx-framework/esx_core).
6
7
7
8
Report bugs using [GitHub issues](https://github.com/acscripts/ac_radio/issues). Use the official [Discord server](https://discord.gg/2ZezMw2xvR) for support.
8
9
@@ -11,12 +12,9 @@ Report bugs using [GitHub issues](https://github.com/acscripts/ac_radio/issues).
11
12
- Channel frequency restrictions for groups/jobs
12
13
- Usable item for [ox_inventory](https://github.com/overextended/ox_inventory) and any ESX / QB inventory
13
14
- Variable frequency limit and step between them
14
-
- Add your own notification system easily
15
-
- Detailed config explanation
16
15
- Tooltips for individual buttons on the radio
17
16
- Buttons for complete volume control (up, down, mute)
0 commit comments