Installation
Nyrox Announce
Last updated: Sep 23, 2026
Nyrox_Announce Wiki
Installation
Extract the folder into your FiveM resources directory.
The folder must be named exactly:
Nyrox_Announce
Then add the following to your server.cfg:
ensure Nyrox_Announce
After that, restart the resource or your server.
restart Nyrox_Announce
Requirements
Nyrox_Announce supports:
ESX
QBCore
The framework can be detected automatically:
Config.Framework = 'auto'
Alternatively, you can set it manually:
Config.Framework = 'esx'
or:
Config.Framework = 'qb'
Admin Groups
No ACE permissions are required.
Allowed groups are configured inside config.lua:
Config.AdminGroups = {
'owner',
'superadmin',
'admin',
'mod'
}
For ESX, the group is checked using:
xPlayer.getGroup()
For QBCore, the configured permissions are checked.
You can add or remove groups at any time.
Example:
Config.AdminGroups = {
'owner',
'admin'
}
/announce Command
The script uses only one main command:
/announce <type> <message>
Example:
/announce info Support is currently available.
Available Types
| Type | Example | Default Color |
|---|---|---|
announce |
/announce announce Welcome! |
Blue |
info |
/announce info Please read the rules. |
Green |
wartung |
/announce wartung Restart in 10 minutes. |
Yellow |
wichtig |
/announce wichtig Support required. |
Red |
For the normal announcement type, you can also use:
/announce normal Message
Configuring Announcement Types
The announcement types are configured inside config.lua.
Config.Types = {
announce = {
Label = 'SERVER ANNOUNCEMENT',
Color = '#3B82F6',
Icon = 'announce'
},
info = {
Label = 'INFORMATION',
Color = '#22C55E',
Icon = 'info'
},
maintenance = {
Label = 'MAINTENANCE',
Color = '#F59E0B',
Icon = 'maintenance'
},
important = {
Label = 'IMPORTANT',
Color = '#F43F5E',
Icon = 'important'
}
}
Changing Colors
All colors are configured using HEX color codes.
Example:
Color = '#3B82F6'
Some examples:
Blue #3B82F6
Light Blue #0EA5E9
Green #22C55E
Yellow #F59E0B
Red #EF4444
Pink #EC4899
Purple #8B5CF6
White #F8FAFC
Changing the Server Name
The server name displayed next to the announcement type can also be customized.
Config.UI = {
ServerName = 'Nyrox Roleplay'
}
Example:
Config.UI = {
ServerName = 'Example Roleplay'
}
Display Duration
The display duration is configured in milliseconds.
Config.DisplayTime = 8000
Examples:
5000 = 5 seconds
8000 = 8 seconds
10000 = 10 seconds
15000 = 15 seconds
Maximum Message Length
Config.MaxLength = 220
This means announcements can contain a maximum of 220 characters.
Example:
Config.MaxLength = 300
Automatic Announcements
Nyrox_Announce can automatically display messages at a configurable interval.
Enable:
Config.AutoAnnounce.Enabled = true
Disable:
Config.AutoAnnounce.Enabled = false
Setting the Interval
Config.AutoAnnounce.IntervalMinutes = 30
This will display an automatic announcement every 30 minutes.
Examples:
Config.AutoAnnounce.IntervalMinutes = 15
Every 15 minutes.
Config.AutoAnnounce.IntervalMinutes = 60
Every hour.
Adding Automatic Announcements
Messages = {
{
Type = 'announce',
Text = 'Welcome to our server!'
},
{
Type = 'info',
Text = 'Please make sure to read our server rules.'
},
{
Type = 'important',
Text = 'If you have any problems, please contact our support team.'
}
}
Each automatic message can use its own announcement type.
Example:
{
Type = 'maintenance',
Text = 'The server will restart in 10 minutes.'
}
Messages in Order
Config.AutoAnnounce.InOrder = true
The messages will be displayed in this order:
Message 1
Message 2
Message 3
Message 1
...
Random Messages
Config.AutoAnnounce.InOrder = false
A random message will be selected each time the interval is reached.
Full Configuration Example
Config = {}
Config.DisplayTime = 8000
Config.MaxLength = 220
Config.Framework = 'auto'
Config.AdminGroups = {
'owner',
'superadmin',
'admin',
'mod'
}
Config.UI = {
ServerName = 'Nyrox Roleplay'
}
Config.Types = {
announce = {
Label = 'SERVER ANNOUNCEMENT',
Color = '#3B82F6',
Icon = 'announce'
},
info = {
Label = 'INFORMATION',
Color = '#22C55E',
Icon = 'info'
},
maintenance = {
Label = 'MAINTENANCE',
Color = '#F59E0B',
Icon = 'maintenance'
},
important = {
Label = 'IMPORTANT',
Color = '#F43F5E',
Icon = 'important'
}
}
Config.AutoAnnounce = {
Enabled = true,
IntervalMinutes = 30,
InOrder = true,
Messages = {
{
Type = 'announce',
Text = 'Welcome to our server!'
},
{
Type = 'info',
Text = 'Please follow our server rules.'
},
{
Type = 'important',
Text = 'If you have any problems, our support team is available.'
}
}
}
Support / Troubleshooting
If /announce does not work, first check whether your admin group is included in:
Config.AdminGroups
If the resource does not start, make sure the folder is named exactly:
Nyrox_Announce
After changing the configuration, it is recommended to restart the resource:
restart Nyrox_Announce
Nyrox_Announce — Simple. Modern. Configurable.