MCPcopy Index your code
hub / github.com/automuteus/automuteus

github.com/automuteus/automuteus @8.3.7

Chat with this repo
repository ↗ · DeepWiki ↗ · release 8.3.7 ↗ · + Follow
562 symbols 1,705 edges 109 files 43 documented · 8%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
<a href="https://automute.us/#/" alt = "Website link"><img src="https://github.com/automuteus/automuteus/raw/8.3.7/assets/AutoMuteUsBanner_cropped.png" width="800"></a>






<a href="https://github.com/automuteus/automuteus/actions?query=build" alt="Build Status">
    <img src="https://github.com/automuteus/automuteus/workflows/build/badge.svg" />
</a>
<a href="https://github.com/automuteus/automuteus/releases/latest">
<img alt="GitHub release" src="https://img.shields.io/github/v/release/automuteus/automuteus" >
</a>
<a href="https://github.com/automuteus/automuteus/graphs/contributors" alt="Contributors">
    <img src="https://img.shields.io/github/contributors/automuteus/automuteus" />
</a>
<a href="https://discord.gg/ZkqZSWF" alt="Discord Link">
    <img src="https://img.shields.io/discord/754465589958803548?logo=discord" />
</a>






<a href="https://hub.docker.com/repository/docker/automuteus/automuteus" alt="Pulls">
    <img src="https://img.shields.io/docker/pulls/denverquane/amongusdiscord.svg" />
</a>
<a href="https://automuteus.crowdin.com/automuteus" alt="localize">
    <img alt="Localize" src="https://badges.crowdin.net/e/5eb1365b5fd16082e63cc54c33736adc/localized.svg">
</a>
<a href="https://goreportcard.com/report/github.com/automuteus/automuteus/v8" alt="Report Card">
    <img src="https://goreportcard.com/badge/github.com/automuteus/automuteus/v8" />
</a>







<a href="https://add.automute.us" alt="invite">
    <img alt="Invite Link" src="https://img.shields.io/static/v1?label=bot&message=invite%20me&color=purple">
</a>

AutoMuteUs

<a href="https://add.automute.us"/>
    <img src="https://github.com/automuteus/automuteus/raw/8.3.7/assets/DiscordBot_Black.gif", width=150>
</a>

AutoMuteUs is a Discord Bot to harness Among Us game data, and automatically mute/unmute players during games!

Requires amonguscapture to capture and relay game data.

Have any questions, concerns, bug reports, or just want to chat? Join our discord at https://discord.gg/ZkqZSWF!

Click the "invite me" badge in the header to invite the bot to your server, or click the GIF on the left.

All artwork for the bot has been generously provided by Smiles!

⚠️ Requirements ⚠️

  1. You must run the Capture application on your Windows PC for the bot to work! Any Among Us games that don't have a user running the capture software will not have automuting capabilities!
  2. The Capture application currently only supports the Steam, Epic Games, itch.io, and Microsoft Store releases of the game, but does not support beta or cracked versions.

Quickstart and Demo (click the image):

Quickstart

Usage and Commands

To start a bot game in the current channel, type the following slash command in Discord after inviting the bot:

/new
# Starts a game, and allows users to react to emojis to link to their in-game players

The bot will send you a private reply with a link that is used to sync the capture software to your game. It will also have a link to download the latest version of the capture software, if you don't have it already.

If you want to view command usage or see the available options, type /help in your Discord channel.

Commands

Command Description Example
/help Print help info and command usage
/new Start a new game in the current text channel
/refresh Remake the bot's status message entirely, in case it ends up too far up in the chat.
/pause Pause the bot, and don't let it automute anyone until unpaused.
/end End the game entirely, and stop tracking players. Unmutes all and resets state
/link Manually link a discord user to their in-game color /link @Soup cyan
/unlink Manually unlink a player /unlink @Soup
/settings View and change settings for the bot, such as the command prefix or mute behavior
/privacy View privacy and data collection information about the bot
/info View general info about the Bot
/map View an image of an in-game map in the text channel. Provide the name of the map, and if you want the detailed version /map skeld true
/stats View detailed stats about Among Us games played on the current server, or by a specific player /stats user view @Soup
/premium View information about AutoMuteUs Premium, and the current premium status of your server

Privacy

You can view privacy and data collection details for the Official Bot here.

Localization

AutoMuteUs now uses CrowdIn for Localization and translations (thanks @MatadorProBr)!

Help us translate the bot here:

Crowdin

To prepare any new strings for translation, first install goi18n v2.1.1 using the following command:

go install -v github.com/nicksnyder/go-i18n/v2/goi18n@v2.1.1

Then run the following command anytime new strings or translations are added:

goi18n extract -outdir locales

Self-Hosting

Self-hosting requires robust knowledge and troubleshooting capability for Docker/Docker-compose, unRAID, Heroku, and/or any other networking and routing config specific to your hosting solution.

As such, we recommend that the majority of users take advantage of our Verified bot. The link to invite our bot can be found here:

Invite Link

If you are certain that you would prefer to self-host the bot, please follow any of the instructions on automuteus/deploy.

Developing

Please refer to the instructions on automuteus/deploy.

Similar Projects

  • Imposter: Similar bot that uses private Discord channels instead of mute/deafen. Also uses a dummy player joining the game and "spectating" to get game information; no capture needed (although loses the 10th player slot).

  • AmongUsBot: Without their original Python program with a lot of the OCR/Discord functionality, I never would have even thought of this idea! Not currently maintained

  • amongcord: A great program for tracking player status and auto mute/unmute in Among Us. Their project works like a traditional Discord bot; very easy installation!

  • Silence Among Us: Another bot quite similar to this one, which also uses AmongUsCapture. Now in early-access with a publicly-hosted instance!

Extension points exported contracts — how you extend this code

PgxIface (Interface)
(no doc)
pkg/storage/postgres.go

Core symbols most depended-on inside this repo

LocalizeMessage
called by 231
pkg/settings/guild_settings.go
GetDiscordGameStateAndLock
called by 23
bot/redis.go
SetDiscordGameState
called by 22
bot/redis.go
MentionWithCacheData
called by 21
bot/stats.go
MentionByUserID
called by 20
pkg/discord/id.go
Exec
called by 17
pkg/storage/postgres.go
CanTransfer
called by 15
pkg/storage/premium.go
ConstructEmbedForSetting
called by 15
bot/setting/settings.go

Shape

Function 265
Method 221
Struct 54
TypeAlias 21
Interface 1

Languages

Go100%

Modules by API surface

pkg/storage/postgres.go46 symbols
pkg/storage/stats.go38 symbols
pkg/settings/guild_settings.go36 symbols
bot/redis.go27 symbols
pkg/rediskey/keys.go19 symbols
pkg/storage/types.go18 symbols
pkg/amongus/gamedata.go15 symbols
bot/tokenprovider/provider.go15 symbols
bot/bot.go15 symbols
common/redis.go13 symbols
pkg/storage/premium.go11 symbols
bot/gameStateMessage.go11 symbols

For agents

$ claude mcp add automuteus \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact