Version Docs

v0.0.5

Setup

Settings

Settings

Information regarding configuring the resources settings file.

You can if you want to edit the bots settings and assign it your own basic info such as name, avatar and default user avatar, however this is not required!

In this section
#

Name

Set the name for the bot to use.

Avatar(s)

Set the default bot and user avatar.

Updates

Enable automatic update checks.

Embeds

Allow the bot to send embed messages.

Name
#

Information regarding assigning the bot a new name in discord.

NOTE

You can skip this step if you are fine with the bots name being SYSTEM for all of its messages.

Open the bots settings
#

Find and open the resources settings.lua file

Find the following line:
#

SystemName = 'SYSTEM',

Add your name
#

Assign it whatever you like for example:

SystemName = 'Toxic Dev Test'

Save and profit!
#

Save your changes and restart the server/resource, your changes can be found inside the channel(s) where the bot sends its logs!

Avatars
#

Information regarding assigning the bot a new avatar/logo and default user logo.

NOTE

You can skip this step if you are fine with the bot using our default bot and user avatar(s)

Open the bots settings
#

Find and open the resources settings.lua file

Find the following lines:
#

SystemAvatar = 'https://wiki.fivem.net/w/images/d/db/FiveM-Wiki.png',
UserAvatar = 'https://i.imgur.com/KIcqSYs.png',

Add your new avatar links:
#

Assign it whatever you like for example:

SystemAvatar = 'https://toxicdev.site/logo.png',
UserAvatar = 'https://toxicdevs.site/user.png',

Save and profit!
#

Save your changes and restart the server/resource, your changes can be found inside the channel(s) where the bot sends its logs!

Updates
#

Information regarding disabling the scripts update checks!

DANGER

Disabling this feature is not recommended however if you do you should know that it will be up to you alone to regularly check for new versions of the script.

Open the bots settings
#

Find and open the resources settings.lua file

Find the following line:
#

UpdateCheck = true,

Assign a new value:
#

Assign it a new value (true/false):

UpdateCheck = false,

Save and profit!
#

Save your changes and restart the server/resource, if you enabled the update checks you should see them in your servers startup logs, or in the logs when you start/restart the resource! if you disabled the checks these logs will no longer show!

Embeds
#

Information regarding enabling/disabling discord message embeds!

NOTE

This setting is entirely up to you if you want it enabled or not!

Open the bots settings
#

Find and open the resources settings.lua file

Find the following line:
#

Messages = {
  UseEmbeds = false,
  EmbedImage = 'https://cdn.discordapp.com/attachments/653733403841134600/1101375870955966514/FiveM.png'
},

Assign a new value:
#

Assign it a new value (true/false):

NOTE

You can assign a new image to be used in the embeds here as well.

Messages = {
  UseEmbeds = true, -- Send the messages to discord as an embed
  EmbedImage = 'https://toxicdevs.site/images/embeds.png'
},

Save and profit!
#

Save your changes and restart the sever/resource, you can find the changes in the channel(s) where the bot sends messages/logs.

Previous

Install

Next

Webhooks

On this page

In this sectionNameAvatarsUpdatesEmbeds