AutoMuteUs CommandsGitHub Reference

The Discord Bot uses the .au prefix for any commands by default; if you change your prefix remember to replace .au with your custom prefix. If you forget your prefix, you can @mention the bot and it will respond with whatever it's prefix currently is.

`cache`View a player's cached in-game names, and/or clear them

Description

View a player's cached in-game names, and/or clear them

Aliases

c

Arguments

Required

Name	Type	Description	Values
@name	string	A Discord user mention (requires the`@`)	-

Optional

Name	Type	Description	Values
clear	string	Will clear the mentioned user's cached names	-

Example

.au cache @Yoshirahh

`end`End the current game

Description

End the current game

Aliases

stope

Arguments

None

Example

.au e

`help`Display bot help message, or see more info about a command

Description

Display bot help message, or see more info about a command

Aliases

h

Arguments

Required

None

Optional

Name	Type	Description	Values
command	string	An AutoMuteUs command to see more info about	-

Example

.au help

`info`View info about the bot, like total guild number, active games, etc.

Description

View info about the bot, like total guild number, active games, etc.

Aliases

infoinfini

Arguments

None

Example

.au info

`link`Manually link a discord user to their in-game color

Description

Manually link a discord user to their in-game color

Aliases

l

Arguments

Required

Name	Type	Description	Values
@name	string	A Discord user mention (requires the`@`)	-
color	string	A crewmate color name	`redbluegreenpinkorangeyellowblackwhitecyanlime`

Example

.au l @Yoshirahh cyan

`map`Display an image of an in-game map in the text channel. Two supported versions: simple or detailed

Description

Display an image of an in-game map in the text channel. Two supported versions: simple or detailed

Aliases

None

Arguments

Required

Name	Type	Description	Values
name	string	Among Us map name	`skeldmira_hqpolus`

Optional

Name	Type	Description	Values
detail	string	Level of map detail (showing vents, sabotages, etc.). `simple` is default, if not provided.	`simpledetailed`

Example

.au map skeld

`new`Start a new game in the current text channel

Description

Start a new game in the current text channel

Aliases

startn

Arguments

None

Example

.au n

`pause`Pause the bot so it doesn't automute/deafen. Will unmute/undeafen all players!

Description

Pause the bot so it doesn't automute/deafen. Will unmute/undeafen all players!

Aliases

unpausep

Arguments

None

Example

.au pause

`premium`View all the features and perks of Premium AutoMuteUs membership.

Description

View all the features and perks of Premium AutoMuteUs membership.

Aliases

donatepaypalprem$

Arguments

None

Example

.au premium

`privacy`AutoMuteUs privacy and data collection details. More details here. Providing no arguments will show this command's help.

Description

AutoMuteUs privacy and data collection details. More details here. Providing no arguments will show this command's help.

Aliases

privateprivgpdr

Arguments

Required

None

Optional

Name	Type	Description	Values
showme	string	Shows your current cached names and data collection opt-out/in status.	-
optin	string	Opt yourself in for game stats data collection.	-
optout	string	Opt yourself out of data collection for game stats.	-

Example

.au privacy showme

`refresh`Remake the bot's status message entirely, in case it ends up too far up in the chat.

Description

Remake the bot's status message entirely, in case it ends up too far up in the chat.

Aliases

reloadrefrelr

Arguments

None

Example

.au r

`settings`Adjust the bot settings. See Settings for more details.

Description

Adjust the bot settings. See Settings for more details.

Aliases

settsets

Arguments

Required

Name	Type	Description	Values
setting	string	Which setting to modify.	-
value	string	What to set the mentioned setting to.	-

Optional

Name	Type	Description	Values
	empty	Provide no arguments to see available settings.	-

Example

.au settings commandPrefix !

`stats`View Player and Guild stats

Description

View Player and Guild stats

Aliases

statst

Arguments

Required

Name	Type	Description	Values
target	string	Which entity you want stats about. Accepts either an @mention for individual users or `guild` for the whole guild.	`@nameguild`

Example

.au stats @Yoshirahh

`unlink`Manually unlink a Discord User from their in-game player.

Description

Manually unlink a Discord User from their in-game player.

Aliases

unulu

Arguments

None

Example

.au unlink @Yoshirahh

`unmuteall`Force the bot to unmute all linked players.

Description

Force the bot to unmute all linked players.

Aliases

unmuteua

Arguments

None

Example

.au unmuteall

Settings

Available configurable settings for the bot and how it displays your data. Access is controlled by appropriate settings listed.

Click on a setting to expand more details about it. Entries listed with a are for premium AutoMuteUs users only.

`adminUserIDs`Specify which individual users have admin bot permissions.

Description

Specify which individual users have admin bot permissions.

Aliases

adminsadminauidauia

Arguments

Required

Name	Type	Description	Values
@names	[string]	A space separated list of at least one Discord user mentions (requires the`@`)	-

Example

.au settings adminUserIDs @Soup @Bob

`autoRefresh`Specify if the bot should auto-refresh the status message after a match ends.

Description

Specify if the bot should auto-refresh the status message after a match ends.

Aliases

refreshautoar

Arguments

Required

Name	Type	Description	Values
setting	boolean	Whether or not the bot auto-refreshes the status message.	`truefalse`

Example

.au settings autoRefresh true

`commandPrefix`Change the prefix that the bot uses to detect commands.

Description

Change the prefix that the bot uses to detect commands.

Aliases

prefixprefcp

Arguments

Required

Name	Type	Description	Values
prefix	string	The desired command prefix.	-

Example

.au settings commandPrefix !

`delays`Specify the delays for automute/deafen between stages of the game, like lobby->tasks.

Description

Specify the delays for automute/deafen between stages of the game, like lobby->tasks.

Aliases

delaysd

Arguments

Required

Name	Type	Description	Values
start_phase	string	Which phase triggers this delay stage.	`lobbytasksdiscussionmenugameover`
end_phase	string	Which phase ends this delay stage.	`lobbytasksdiscussionmenugameover`
delay	string	Time of delay in seconds.	-

Example

.au settings delays lobby tasks 5

`language`Change the bot messages language.

Description

Change the bot messages language.

Aliases

locallangl

Arguments

Required

Name	Type	Description	Values
language	string	The language code to change to.	-

Optional

Name	Type	Description	Values
'reload'	exact	Reloads current language settings.	-

Example

.au settings language ru

`leaderboardMention`If players should be mentioned with @ on the leaderboard. Disable this for large servers!

Description

If players should be mentioned with @ on the leaderboard. Disable this for large servers!

Aliases

lboardmentionleadermentionmentionment

Arguments

Required

Name	Type	Description	Values
setting	boolean	Whether players are @ mentioned on the leaderboard.	`truefalse`

Example

.au settings leaderboardMention true

`leaderboardMin`Minimum amount of games before a player is displayed on the leaderboard.

Description

Minimum amount of games before a player is displayed on the leaderboard.

Aliases

lboardminboardminleaderminmin

Arguments

Required

Name	Type	Description	Values
value	number	The minimum number of games required.	-

Example

.au settings leaderboardMin 3

`leaderboardSize`Specify the size of the player leaderboard.

Description

Specify the size of the player leaderboard.

Aliases

lboardsizeboardsizeleadersizesize

Arguments

Required

Name	Type	Description	Values
size	number	Size of the player leaderboard.	-

Example

.au settings leaderboardSize 5

`mapVersion`Specify the default map version (simple, detailed) used by 'map' command.

Description

Specify the default map version (simple, detailed) used by 'map' command.

Aliases

map

Arguments

Required

Name	Type	Description	Values
version	string	Which version of the map to display by default.	`simpledetailed`

Example

.au settings mapVersion detailed

`matchSummary`Specify minutes before the match summary message is deleted. 0 for instant deletion, -1 for never delete.

Description

Specify minutes before the match summary message is deleted. 0 for instant deletion, -1 for never delete.

Aliases

matchsummmatchsumsummarymatchsummsum

Arguments

Required

Name	Type	Description	Values
minutes	number	How long before match summary message is deleted.	`0 (instant)-1 (never)# > 0`

Example

.au settings matchSummary 5

`matchSummaryChannel`Specify the text channel name where Match Summaries should be posted.

Description

Specify the text channel name where Match Summaries should be posted.

Aliases

matchsummchanmatchsumchansummarychannelmatchchannelsummchansumchan

Arguments

Required

Name	Type	Description	Values
channel	string	Text channel name.	-

Example

.au settings matchSummaryChannel general

`muteSpectators`Whether or not the bot should treat spectators like dead players (respecting your voice rules). Note, this can cause delays or slowdowns when not self-hosting, or using a Premium worker bot!

Description

Whether or not the bot should treat spectators like dead players (respecting your voice rules). Note, this can cause delays or slowdowns when not self-hosting, or using a Premium worker bot!

Aliases

mutespectatormutespecspectatorsspectatorspec

Arguments

Required

Name	Type	Description	Values
setting	boolean	Whether to treat spectators like dead players.	`truefalse`

Example

.au settings muteSpectators true

`operatorRoles`Specify which roles have permissions to invoke the bot.

Description

Specify which roles have permissions to invoke the bot.

Aliases

operatorsoperatoroprolesrolesroleopsop

Arguments

Required

Name	Type	Description	Values
@role	string	A Discord role mention (requires the`@`)	-
role	string	A AutoMuteUs user role	`AdminsMods`

Example

.au settings operatorRoles @Bot Admins @Bot Mods

`reset`Reset all bot settings. CAUTION: this will take effect immediately, without confirmation.

Description

Reset all bot settings. CAUTION: this will take effect immediately, without confirmation.

Aliases

None

Arguments

None

Example

.au settings reset

`show`Output a JSON of all current bot settings.

Description

Output a JSON of all current bot settings.

Aliases

None

Arguments

None

Example

.au settings show

`unmuteDeadDuringTasks`Specify if the bot should immediately unmute players when they die. CAUTION: Leaks information!

Description

Specify if the bot should immediately unmute players when they die. CAUTION: Leaks information!

Aliases

unmutedeadunmuteuddtud

Arguments

Required

Name	Type	Description	Values
setting	boolean	Whether or not dead are unmuted during tasks.	`truefalse`

Example

.au settings unmuteDeadDuringTasks false

`voiceRules`Specify mute/deafen rules for the game, depending on the stage and the alive/deadness of players. Example given would mute dead players during the tasks stage.

Description

Specify mute/deafen rules for the game, depending on the stage and the alive/deadness of players. Example given would mute dead players during the tasks stage.

Aliases

voicevr

Arguments

Required

Name	Type	Description	Values
rule	string	Which voice rule to modify.	`mutedeaf`
game_phase	string	Which phase to invoke this voice rule in.	`lobbytasksdiscussionmenugameover`
liveness	string	Whether the player needs to be alive or dead for this rule.	`deadalive`
enabled	boolean	Whether this voice rule is in effect.	`truefalse`

Example

.au settings voiceRules mute tasks dead true

AutoMuteUs CommandsGitHub Reference

cacheView a player's cached in-game names, and/or clear them

Description

Aliases

Arguments

Required

Optional

Example

endEnd the current game

Description

Aliases

Arguments

Example

helpDisplay bot help message, or see more info about a command

Description

Aliases

Arguments

Required

Optional

Example

infoView info about the bot, like total guild number, active games, etc.

Description

Aliases

Arguments

Example

linkManually link a discord user to their in-game color

Description

Aliases

Arguments

Required

Example

mapDisplay an image of an in-game map in the text channel. Two supported versions: simple or detailed

Description

Aliases

Arguments

Required

Optional

Example

newStart a new game in the current text channel

Description

Aliases

Arguments

Example

pausePause the bot so it doesn't automute/deafen. Will unmute/undeafen all players!

Description

Aliases

Arguments

Example

premiumView all the features and perks of Premium AutoMuteUs membership.

Description

Aliases

Arguments

Example

privacyAutoMuteUs privacy and data collection details. More details here. Providing no arguments will show this command's help.

Description

Aliases

Arguments

Required

Optional

Example

refreshRemake the bot's status message entirely, in case it ends up too far up in the chat.

Description

Aliases

Arguments

Example

settingsAdjust the bot settings. See Settings for more details.

Description

Aliases

Arguments

Required

Optional

Example

statsView Player and Guild stats

Description

Aliases

Arguments

Required

Example

unlinkManually unlink a Discord User from their in-game player.

Description

`cache`View a player's cached in-game names, and/or clear them

`end`End the current game

`help`Display bot help message, or see more info about a command

`info`View info about the bot, like total guild number, active games, etc.

`link`Manually link a discord user to their in-game color

`map`Display an image of an in-game map in the text channel. Two supported versions: simple or detailed

`new`Start a new game in the current text channel

`pause`Pause the bot so it doesn't automute/deafen. Will unmute/undeafen all players!

`premium`View all the features and perks of Premium AutoMuteUs membership.

`privacy`AutoMuteUs privacy and data collection details. More details here. Providing no arguments will show this command's help.

`refresh`Remake the bot's status message entirely, in case it ends up too far up in the chat.

`settings`Adjust the bot settings. See Settings for more details.

`stats`View Player and Guild stats

`unlink`Manually unlink a Discord User from their in-game player.

`unmuteall`Force the bot to unmute all linked players.

`adminUserIDs`Specify which individual users have admin bot permissions.

`autoRefresh`Specify if the bot should auto-refresh the status message after a match ends.

`commandPrefix`Change the prefix that the bot uses to detect commands.

`delays`Specify the delays for automute/deafen between stages of the game, like lobby->tasks.

`language`Change the bot messages language.

`leaderboardMention`If players should be mentioned with @ on the leaderboard. Disable this for large servers!

`leaderboardMin`Minimum amount of games before a player is displayed on the leaderboard.

`leaderboardSize`Specify the size of the player leaderboard.

`mapVersion`Specify the default map version (simple, detailed) used by 'map' command.

`matchSummary`Specify minutes before the match summary message is deleted. 0 for instant deletion, -1 for never delete.