Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/automuteus/automuteus
Discord Bot to automute Among Us players at round transitions, in conjunction with https://github.com/automuteus/amonguscapture
https://github.com/automuteus/automuteus
among-us automute automuteus bot capture discord discord-bot go golang
Last synced: 21 days ago
JSON representation
Discord Bot to automute Among Us players at round transitions, in conjunction with https://github.com/automuteus/amonguscapture
- Host: GitHub
- URL: https://github.com/automuteus/automuteus
- Owner: automuteus
- License: mit
- Created: 2020-09-11T22:39:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T20:06:53.000Z (about 1 month ago)
- Last Synced: 2024-10-02T03:41:40.003Z (about 1 month ago)
- Topics: among-us, automute, automuteus, bot, capture, discord, discord-bot, go, golang
- Language: Go
- Homepage: https://automute.us
- Size: 22.7 MB
- Stars: 945
- Watchers: 24
- Forks: 285
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - automuteus
README
# AutoMuteUs
AutoMuteUs is a Discord Bot to harness Among Us game data, and automatically mute/unmute players during games!
Requires [amonguscapture](https://github.com/automuteus/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](https://github.com/automuteus/amonguscapture/releases/latest) 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](https://github.com/automuteus/amonguscapture/releases) 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):
[](https://youtu.be/VYx6kM1O4FM)
# 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](PRIVACY.md).
# Localization
AutoMuteUs now uses [CrowdIn](https://crowdin.com/) for Localization and translations (thanks @MatadorProBr)!
Help us translate the bot here:
[](https://automuteus.crowdin.com/automuteus)
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/[email protected]
```
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:
If you are certain that you would prefer to self-host the bot, please follow any of the instructions on [automuteus/deploy](https://github.com/automuteus/deploy).
# Developing
Please refer to the instructions on [automuteus/deploy](https://github.com/automuteus/deploy).
# Similar Projects
- [Imposter](https://github.com/molenzwiebel/Impostor): 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](https://github.com/alpharaoh/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](https://github.com/pedrofracassi/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](https://github.com/tanndev/silence-among-us#silence-among-us): Another bot quite similar to this one, which also uses AmongUsCapture. Now in early-access with a publicly-hosted instance!
