FiveUnityManual

Core settings

Core is where the everyday basics live: which channels the bot writes its logs to, how new members are greeted, boosters and verification, the message-command prefix, your Tebex store, and the danger zone that wipes everything.

Note

Where: Dashboard โ†’ Core ยท In Discord: /setup โ†’ Configuration Dashboard โ†’ Core

#Logging channels

Pick a channel for each kind of log. Anything left empty is simply not logged: the bot never falls back to another channel.

LogWhat lands there
message logMessages deleted (with who deleted them, when the audit log says) and messages edited, showing the text before and after. Messages from bots are skipped, and a message the bot never saw shows as "Unavailable (message not cached)".
member logMembers joining and leaving, kicks, bans (with reason and who banned) and unbans.
boost logA member starting or stopping a boost, and the server reaching a new Boost Level. The thank-you embed for a new booster is posted separately in the booster channel, see below.
channel logChannels created and deleted, channel name and topic changes, and voice activity: joining, leaving, server mute, server deafen.
ticket logThe whole ticket lifecycle: opened, claimed, members added or removed, renamed, escalated, closed (with the transcript link) and deleted.
staff logStaff actions: clock in and clock out, message purges, /echo, department clock resets and forced clock-outs, gang strikes added and removed. It also catches AutoMod hits, ghost pings, anti-raid lockdowns and anti-nuke alerts when no dedicated alert channel is set on the Protection page.
review logStar ratings members leave after a ticket is closed: the rating out of 5, any written feedback, and the staff who were rated.
other logEverything else, and it is busy: roles created, deleted, renamed or recoloured, roles added to or removed from a member, nickname changes, whether a warn/kick/timeout DM reached the member, and a running "Info Log" of configuration changes, gang and department activity, role requests and FiveM actions.
security logAnti-raid and anti-nuke actions, lockdowns, a role link that would have granted Administrator, and every command or staff button a member was refused.
command logSlash commands your staff run, with the options they passed.
error logInternal FiveUnity errors raised while handling this server. Useful when you are reporting a problem to support.
Note

The security, command and error channels were not being saved before version 1.1.0: the setting appeared to take but was discarded. If you set one of them before that release, set it again.

Create logging channels builds the set for you. Leave Create under category empty and the bot makes a Discord Logs category, or pick an existing category to build inside. It creates a channel for each log type and fills in the pickers. If any log channel is already set and still exists, it stops and tells you logs are already set up.

Staff and review logs are not part of that set. /setup โ†’ Tickets โ†’ Run Default Setup creates them as staff-logs and review-logs inside a hidden FiveUnity System category, or you can point the two pickers at channels of your own.

Note

The fivem log picker does not receive anything today. In-game FiveM logs use the channels on the FiveM page instead.

Press Save settings (or the save bar at the bottom) after changing any picker.

#Welcome & roles

SettingWhat it does
Welcome channelWhere the join greeting is posted, as an embed with the member's avatar, or as the generated card on its own when that is on. Both a channel and a message are needed before anything is posted.
Welcome messageThe greeting text, up to 1,000 characters. {user} and {server} are replaced. Nothing else is. Clear it and it goes back to "Welcome {user} to {server}! Enjoy your stay."
Welcome image URLOptional direct http(s) picture shown inside the greeting embed. The Core panel previews the result as you edit. Ignored while the generated card is on.
Welcome footerOptional footer text at the bottom of the greeting embed. Ignored while the generated card is on.
Generated Discord cardCreates a Discord-focused PNG with the member's avatar, display name, username, Discord ID, server, member count and account age. You can hide any of the last three and choose the heading/accent colour. While it is on, the card is posted on its own and replaces the whole greeting embed: the message text, the image URL and the footer are not sent. A welcome message is still required before anything is posted.
Auto rolesRoles given to every member the moment they join. Up to 50.
Staff roleStored with your server settings. Staff powers in FiveUnity come from permission groups, not from this field.
Admin roleGiven permission to see the FiveM audit-log channel when the bot creates it.

Role bindings (letting one role hand out a fixed set of other roles through /role) are set in Discord with /setup โ†’ Core โ†’ Setup Role Bindings, or with /role-bindings.

#Booster & verification

Turn the section on with the Booster thanks switch.

SettingWhat it does
Booster roleRecorded against your server; the thank-you message below is what actually fires.
Booster channelWhere the "New Server Boost!" embed is posted when a member starts boosting.
Booster thank-you messageUp to 1,000 characters. {user} becomes the booster, {server} the server name, {count} the current boost count.
Verification gateMarks the gate as on in the setup summary.
Verification channelWhere Post verification panel puts the panel.
Verified roleGiven when someone presses Verify. Required before the panel can be posted.
Unverified roleGiven automatically to every member on join, and removed again when they verify.
Send welcome DM on joinDMs new members the message below.
Welcome DM messageUp to 1,000 characters, with {user} and {server} replaced. Nothing is sent if this is empty.

Post verification panel posts an embed with a green Verify button; pressing it adds the verified role and strips the unverified role. Re-posting updates the existing panel rather than adding a second one. The gate itself is the pair of roles: set an unverified role that cannot see your channels, and members stay locked out until they verify.

Warning

If Send welcome DM on join is greyed out, welcome DMs are currently switched off across the whole bot. Unsolicited join DMs are what Discord's anti-spam system acts on, so this is a safety measure.

#Bot prefix

The prefix for the bot's message commands, 1 to 10 characters, ! by default. /setprefix does the same thing from Discord and needs Administrator.

#Tebex

Your store's integration type, secret key, webhook and per-event log channels live in this section. See Tebex store for the full walkthrough.

#Delete channels

Empties a category: every channel inside it is deleted from Discord, along with their messages. Use it to clear out a category the bot built, or any other category you are done with.

Only the server owner sees this section, and only the server owner can use it. Administrator is not enough here, unlike the Danger zone below. Administrator is a role anyone holding it can hand to somebody else, and a deleted channel is not something FiveUnity can restore, so this one is locked to the account Discord itself treats as the server.

To run it:

  1. Pick the Category. The line underneath names every channel that would go.
  2. Decide whether to Also delete the category or empty it and leave it in place.
  3. Type the category name exactly, including capitals. Not the server name: typing the thing you are deleting is what proves you picked the right one.
  4. Leave Stop FiveUnity recreating these on unless you want them back. FiveUnity rebuilds a missing Tebex log channel when the next sale needs it, so without this the delete would be undone by the next webhook. With it on, the log types you deleted are added to the Tebex Muted events list instead.
  5. Press Delete these channels.

Whatever is deleted is also forgotten: every setting that pointed at one of those channels is cleared, so nothing is left aiming at a channel that no longer exists.

Up to 200 channels go per press, they are deleted one at a time so Discord does not rate-limit the bot, and a channel FiveUnity cannot delete is reported back by name rather than stopping the rest. FiveUnity needs Discord's Manage Channels permission.

Danger

There is no undo. Deleted channels and their messages are gone from Discord, and a FiveUnity backup does not restore them.

#Danger zone

This wipes every setting the bot stores for this server: core settings, tickets and panels, queues, applications, departments, gangs, permission groups, purchases, player stats and ban evidence. There is no undo and no backup is taken for you.

To run it:

  1. Type the server name into Type the server name to confirm. It has to match exactly, including capitals.
  2. Decide whether to Also delete the channels the bot created. Left off, the channels and categories stay where they are and only the stored settings go. Turned on, the bot also deletes every channel and category it had recorded: log channels, the verification channel, Tebex log channels, ticket queue categories, application and gang categories, the FiveM status and restart channels, and more.
  3. Press Reset this server and confirm.

Only the server owner or a member with Discord's Administrator permission can do this (Manage Server is not enough) and a reset can only be run once every 10 minutes.

/factory-reset is the Discord equivalent. It is stricter still: only the server owner can run it, it takes delete_channels as an option instead of a switch, and it asks you to confirm with a button within 15 seconds rather than typing the server name.

Danger

Save a backup before you reset. A backup restores your roles and channels; it does not restore FiveUnity's settings, but it saves you rebuilding the server by hand.