FiveUnityManual

Utility commands

The Utility category is the general toolbox: embeds, giveaways, polls, keyword replies, self role panels, stats channels, sticky messages, translation, verification and the Tebex integration. See How commands work for the option table format and the permission model.

Note

Most Utility commands land on the Admin step of the default ladder, so anyone from Admin upwards has them, along with the server owner and Discord Administrators. The exceptions are marked per command: /help, /leaderboard, /ping and /store are open to every member; /echo is limited to the server owner and cannot be granted to anyone else; and /fivem-heal, /fivem-revive and /fivem-clothing are in the FiveM permission category, which starts at Management by default. See Permissions.

#/echo

Sends a message as the bot. Server owner only.

OptionRequiredWhat it is
messageYesThe message to send.
channelNoThe text channel to send it in. Defaults to the channel you are in.

Mentions inside the message are written out but never ping anyone, so you cannot use /echo to mass-ping the server. Every use is written to your command log.

Because anything sent this way looks like it came from the bot itself, /echo is the one staff command that is not on the permission ladder at all. Only the account that owns the Discord server can run it: an Administrator, a Management group, even a group holding every permission (*) gets Access Denied. There is no setting that opens it up, so if you want a staff member to be able to post as the bot, build them a message in the embed builder instead.

Who can use it: the server owner only ยท Discord permission: Administrator (Discord has no owner-only setting, so the command hides itself from everyone below Administrator and then refuses anyone who is not the owner).

text
/echo message:Server restarting in 10 minutes. channel:#announcements

#/embed

Manages custom and saved embeds.

OptionRequiredWhat it is
createn/aSubcommand: build a new embed in a pop-up form (title, description, colour, footer) and send it.
create channelYesThe channel to send the embed in.
sendn/aSubcommand: send one of your saved embeds.
send nameYesThe name of the saved embed, from autocomplete.
send channelYesThe channel to send it to.
listn/aSubcommand: list all of your saved embeds.
get-textn/aSubcommand: get the raw text of a saved embed so you can copy it.
get-text nameYesThe name of the saved embed, from autocomplete.
deleten/aSubcommand: delete one of your saved embeds.
delete nameYesThe name of the saved embed to delete, from autocomplete.
postn/aSubcommand: post a server embed template built on the dashboard, every message in order.
post templateYesThe name of the server template, from autocomplete.
post channelYesThe channel, forum or thread to post the template in. A forum gets a new post titled by the first message's forum post title.
post message-idNoEdit this existing message with the template's first message instead of posting it. FiveUnity can edit messages it sent itself or through its own webhook.
updaten/aSubcommand: edit the messages a server template posted last time, in place, wherever they went.
update templateYesThe name of the server template, from autocomplete.
templatesn/aSubcommand: list the server embed templates built on the dashboard.

Saved embeds are personal; only you can send or delete the ones you saved. Templates belong to the server and are built on the dashboard. Posting a template that pings @everyone needs Mention Everyone, and one that posts under a custom name and avatar needs Manage Webhooks, from you as well as the bot. See Embeds.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

text
/embed post template:rules channel:#rules
/embed update template:rules

#/giveaway

Manages giveaways.

OptionRequiredWhat it is
startn/aSubcommand: start a new giveaway.
start prizeYesWhat the prize is.
start durationYesHow long the giveaway lasts, written as 30m, 1h, 2d and so on.
start winnersYesHow many winners to draw.
start channelYesThe channel to post the giveaway in.

Members enter with an Enter button on the giveaway message. If giveaways are switched off under Modules, the command says so and does nothing. See Modules and utilities.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

text
/giveaway start prize:Custom vehicle slot duration:2d winners:1 channel:#giveaways

#/help

Lists all available commands or info about a specific command.

OptionRequiredWhat it is
commandNoThe command to get help for, from autocomplete. Leave it out for the category menu.

/help can never be turned off and is open to every member, so anyone can browse what the bot offers. It lists the commands that exist on this server, not the ones the reader personally may run. See How commands work.

Who can use it by default: every member. It lists what exists, not what the member may run.

text
/help command:ticket

#/keyword

Manages keyword auto-responses.

OptionRequiredWhat it is
createn/aSubcommand: create a custom keyword response.
create keywordYesThe word or phrase to respond to. Stored in lower case.
create responseYesThe message the bot will send.
deleten/aSubcommand: delete a keyword response.
delete keywordYesThe keyword to delete, from autocomplete.
listn/aSubcommand: list all active keyword responses.
defaultsn/aSubcommand: pick a ready-made response from a drop-down and add it to your server.
editn/aSubcommand: change the response for an existing keyword.
edit keywordYesThe keyword to edit, from autocomplete.
edit new-responseYesThe new message the bot will send.

Keyword replies need no prefix (they fire on the word appearing in a message) and only while the keyword responder is switched on under Modules. See Modules and utilities.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

text
/keyword create keyword:rules response:Read the rules in #rules before you connect.

#/leaderboard

View server leaderboards.

OptionRequiredWhat it is
typeYesWhich leaderboard to view: Cash, Bank or Playtime.

Shows the top ten players. It only has data once your FiveM server is syncing player stats. See FiveM commands.

Who can use it by default: every member.

text
/leaderboard type:Playtime

#Open in Embed Builder

Opens a message in the dashboard's Embed Builder, the way Discohook's Restore to Discohook does.

This is not a slash command. Right-click (or long-press) any message, choose Apps โ†’ Open in Embed Builder, and follow the link. If FiveUnity posted the message (as itself or through its webhook), sending from the builder edits it in place; any other message opens as a copy. The dashboard checks that you can read that channel. See Embeds.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

#/ping

Replies with Pong!

No options. Use it to confirm the bot is online and responding in your server.

Who can use it by default: every member.

text
/ping

#/poll

Creates a poll for the server to vote on.

OptionRequiredWhat it is
questionYesThe question for the poll.
channelYesThe text channel to send the poll to.
option-1YesThe first choice.
option-2YesThe second choice.
option-3NoThe third choice.
option-4NoThe fourth choice.
option-5NoThe fifth choice.

FiveUnity posts the poll and adds a numbered reaction for each choice. If polls are switched off under Modules, the command says so and does nothing.

Who can use it by default: the Moderator group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

text
/poll question:Next event night? channel:#polls option-1:Friday option-2:Saturday

#Save Embed

Saves an embed from an existing message so you can re-send it later with /embed send.

This is not a slash command. Right-click (or long-press) a message that contains an embed, choose Apps โ†’ Save Embed, and give it a name in the pop-up form. Names have to be unique per person. See Embeds.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

#/selfroles

Build panels members use to give themselves roles.

OptionRequiredWhat it is
createn/aSubcommand: create an empty self role panel.
create nameYesShort name used to manage the panel later.
create titleNoHeading shown on the panel embed.
create descriptionNoBody text shown on the panel embed.
create styleNoHow members pick roles: Buttons or Dropdown.
create modeNoWhether members can hold Multiple roles from the panel or One role only.
create max_rolesNoCap on roles from this panel, 0 to 25. 0 means unlimited.
create required_roleNoA role a member must already have to use the panel.
addn/aSubcommand: add a role to a panel.
add nameYesThe panel to add to.
add roleYesThe role members can give themselves.
add labelNoButton or option label. Defaults to the role name.
add descriptionNoExtra line shown on dropdown options.
add emojiNoEmoji shown next to the role.
removen/aSubcommand: remove a role from a panel.
remove nameYesThe panel to remove from.
remove roleYesThe role to drop.
sendn/aSubcommand: post the panel to a channel, replacing any earlier copy.
send nameYesThe panel to post.
send channelYesWhere to post it.
listn/aSubcommand: list every self role panel in this server, with its style, mode, role count and where it is posted.
deleten/aSubcommand: delete a panel and its posted message.
delete nameYesThe panel to delete.

A role is refused if FiveUnity cannot hand it out, for instance when the role sits above the bot's own. See Roles.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท Discord permission: Manage Roles.

text
/selfroles create name:pings style:Buttons mode:Multiple roles

#/statschannel

Manages self-updating statistic channels.

OptionRequiredWhat it is
setupn/aSubcommand: create a category with a default set of stat channels in one go. Safe to run twice: it only creates the ones you do not already have.
force-updaten/aSubcommand: immediately refresh this server's statistic channels.
createn/aSubcommand: create a single new statistic channel.
create typeYesWhat to display: Total Members, Online Members, Role Member Count, Members in Voice, Server Boost Count, Banned Member Count, Text Channel Count or Voice Channel Count.
create nameYesThe channel name template. Use {count} where the number should go. Discord caps a channel name at 100 characters once the number is filled in.
create roleNoThe role to count. Only needed for the Role Member Count type.
deleten/aSubcommand: delete a statistic channel.
delete channelYesThe stat channel to delete.

Stat channels stop refreshing while the stats channels module is switched off. FiveUnity needs Manage Channels to create them.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

text
/statschannel create type:Total Members name:๐Ÿ‘ฅ Members: {count}

#/sticky

Manages sticky messages in channels.

OptionRequiredWhat it is
setn/aSubcommand: set or update a sticky message in a channel.
set channelYesThe channel to set the sticky message in.
set messageYesThe message to stick to the bottom of the channel.
removen/aSubcommand: remove the sticky message from a channel.
remove channelYesThe channel to remove it from.

The sticky message is re-posted at the bottom of the channel as people talk, so it stays visible. It only does that while sticky messages are switched on under Modules.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

text
/sticky set channel:#support message:Open a ticket rather than asking here.

#/store

Displays the link to the community store.

No options. If no store link is configured you get a private notice instead. Set the Store link field in your community settings, or through /setup. See Community.

Who can use it by default: every member.

text
/store

#/tebex

Manages the Tebex integration.

OptionRequiredWhat it is
setupn/aSubcommand: set up the Tebex integration for the server.
setup methodYesDirect Discord Webhook for simple logging, or Express Server for advanced sync.
setup log-channelNoThe channel to send webhook logs to. Required for the Direct Webhook method.
lookupn/aSubcommand: look up the five most recent purchases for a user.
lookup userYesThe user to look up purchases for.
verifyn/aSubcommand: confirm a purchase code from Express webhook history (and live Tebex when a Game Server secret is accepted).
verify codeYesThe transaction id from the purchase email or control panel (usually starts with tbx-).
forcecheckn/aSubcommand: re-post up to ten purchases from the last 14 days that nobody has marked as processed.

Choosing Express Server gives you a button that opens a private form for your Tebex secret key, so the key never appears as a command option or in your logs. The Direct Webhook method is simpler but does not support /tebex lookup or /tebex verify. See Tebex store.

Who can use it by default: the Senior Admin group and above, plus the server owner and Discord Administrators ยท Discord permission: Administrator.

text
/tebex lookup user:@Customer
/tebex verify code:tbx-xxxxxxxx

#/translate

Manages the server's automatic translation features.

OptionRequiredWhat it is
auto togglen/aTurn automatic translation of non-English messages into English on or off for the whole server.
auto ignore-channeln/aToggle auto-translation off (or back on) for the channel you run it in.
reaction togglen/aTurn on-demand translation on or off. With it on, anyone reacting ๐ŸŒ to a message gets it translated.
conversation startn/aStart a two-way translated conversation in this channel.
conversation start languageYesThe second language for the conversation, such as es for Spanish. English is always the first.
conversation stopn/aStop the two-way conversation in this channel.

Each toggle flips the current setting and the reply tells you which way it went. If the translator is switched off under Modules the command says so and does nothing.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท No Discord permission is set, so FiveUnity's permission check does the gating.

text
/translate conversation start language:es

#/vanity

Manages vanity roles that users can claim if they have a specific phrase in their status.

OptionRequiredWhat it is
setupn/aSubcommand: set up the vanity role system.
setup roleNoThe role to assign. Defaults to a role named "Vanity", created for you if it does not exist.
setup phraseNoThe phrase to look for in member statuses. Defaults to "Five Unity".
setup messageNoCustom message sent when a member gets the role. Use {user} and {role} as placeholders.
removen/aSubcommand: remove a vanity role setup.
remove roleYesThe vanity role to remove.
listn/aSubcommand: list all configured vanity roles.

Setup also creates a vanity-rewards showcase channel if the server has not got one.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท Discord permission: Manage Server.

text
/vanity setup phrase:.gg/yourserver

#/verification

Manage the verification system.

OptionRequiredWhat it is
setupn/aSubcommand: post the verification panel in the channel you run it in.

Set the verification role first, under /setup โ†’ Moderation Panel โ†’ Verification, or the button on the panel will not do anything. Posting the panel also marks that channel as your verification channel and switches verification on.

Who can use it by default: the Admin group and above, plus the server owner and Discord Administrators ยท Discord permission: Manage Server.

text
/verification setup