This documentation goes over everything needed for our RTO System. Information about the config and setup is all stated below.
Go to the github and download via the releases page.
Make sure you have the most recent version of the RTO System.
You will need to have at least Node.js version14.17.6installed onto your computer.
Note: The folder name, ie RTO System can be anything you want.
RTO System.rto-system-1.0.0 from the zip file.RTOSystemLink into your resources folder within your FiveM server.npm i and wait for it to install all the modules.This menu has serveral configurable settings that are easily changed within the config.lua.
You can find a blank/original config.lua in the Resrouce section of this page.
When editing the config be careful not to delete or rename variables. Also do not remove {}, "", or anything of that nature.
This defines the bot's prefix.
The bot can also be pinged as a form of prefix.
This is the bot's prefix wich you get from the Discord Developer Page.
More information on how to get a token.
This defines the voice channel that the bot will be in at all times it is active.
You can not have multiple channels list! Only one discord bot account per channel.
This tells the bot weather you want the log messages to be sent or not.
On = "true"
Off = "false"
Do NOT add capitals to true or false. Just use true or false within the quotes.
This is the text channel that all logs will be sent to if useLogs is on.
This is the text channel that your in-game webhook is. It can be the same as logchannelID.
You need to ensure the webhook is within this channel or in game commands will not work! (Next Section)
These are the role(s) that are required to have to be able to do the signal, pager, and panic commands within Discord.
You must keep the [] around it no matter how many roles you have!
Single role example:
"neededRoles": ["roleid"],
Multi role example:
"neededRoles": ["roleid", "roleid2", "roleid3"],
These are the role(s) that are required to have to be able to do the mute commands within Discord.
You must keep the [] around it no matter how many roles you have!
Single role example: "adminRoles": ["roleid"],
Multi role example: "adminRoles": ["roleid", "roleid2", "roleid3"],
This is the time in seconds that you want people to be muted after someone else starts/stops speaking.
The bot will only mute people if muteMode is on.
This defines weather the bot will mute people based on muteTimer.
Do NOT add capitals to on or off, and do not try to use true or false. Just use on or off within the quotes.
This tells the bot weather you want it to make the mic click sounds when people start/stop talking.
We strongly recommend you have the channel set to push to talk ONLY, as the bot will make the mic click anytime a person's mic activates.
Do NOT add capitals to on or off, and do not try to use true or false. Just use on or off within the quotes.
This tells the bot weather you want the sounds to activate when someones uses the in-game command.
On = "true"
Off = "false"
Do NOT add capitals to true or false. Just use true or false within the quotes.
This enables or disables the pager commands for both the bot and in-game.
Do NOT add capitals to on or off, and do not try to use true or false. Just use on or off within the quotes.
This enables or disables the signal commands for both the bot and in-game.
Do NOT add capitals to on or off, and do not try to use true or false. Just use on or off within the quotes.
This enables or disables the panic command for both the bot and in-game.
Do NOT add capitals to on or off, and do not try to use true or false. Just use on or off within the quotes.
The in-game script runs off of Ace Permissions.
To give a group permission to use the commands just add add_ace rto_system allow into your server.cfg.
If you are looking to use Discord permissions then use Badger's Discord Ace Permissions.
RTOSystemLink. Take that and place it within your FiveM server's resource folder. (You can organize it however you want.)start RTOSystemLink with your server.cfg.config.lua.Make sure the webhook is set to the same channel as the channel ID set in the bot's
config.jsin"webchannelID": "".
{
"prefix": ".",
"token": "",
"channelID": "",
"useLogs": "true",
"logchannelID": "",
"webchannelID": "",
"neededRoles": ["", "", ""],
"adminRoles": ["", ""],
"muteTimer": "5",
"muteMode": "off",
"micClicks": "on",
"inGameActivation": "true",
"pager": "on",
"signal": "on",
"panic": "on"
}
--[[
───────────────────────────────────────────────────────────────
RTO System In-Game Link (config.lua) - Created by Shadow Development
Website: https://shadowdevs.com
Documentation: https://docs.shadowdevs.com/rtosystem
Discord: https://discord.shadowdevs.com
───────────────────────────────────────────────────────────────
]]
Config = {}
Config.DiscordWebook = 'https://discord.com/api/webhooks/'
-- Add your discord webhook url above