amongusdiscord

amongusdiscord

Docker app from argash's Repository

Overview

Discord Bot to harness Among Us game data, and automatically mute/unmute players during the course of the game! Works in conjunction with amonguscapture This program is in Beta. While we are confident about the basic functionality, there will still be issues or pecularities with how the program functions! We are actively working to resolve these issues! Have any questions, concerns, bug reports, or just want to chat? Join the discord at https://discord.gg/ZkqZSWF! Unraid template by Argash Updates: 2020-10-20 - Updated template with new environment variables rework in bot version 2.4.0

GitHub release

Localize

Invite Link

AutoMuteUs

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!

Install Amongusdiscord on Unraid in a few clicks.

Find Amongusdiscord in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Amongusdiscord Review the template variables and paths Click Install

Download Statistics

797,563
Total Downloads
273
This Month
1,127
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Details

Repository
denverquane/amongusdiscord
Last Updated2022-02-15
First Seen2020-10-15

Runtime arguments

Network
br0
Shell
sh
Privileged
false

Template configuration

DISCORD_BOT_TOKENVariable

The Bot Token used by the bot to authenticate with Discord.

PORTPorttcp

The port the Bot will use for incoming Socket.io communications from the capture client. Defaults to 8123. You must specify more (comma-delimited ports) if you are running with NUM_SHARDS > 1. For example, with 3 shards, PORT = 8123,8124,8125

Target
8123
Default
8123
Value
8123
HOSTVariable

The externally-accessible URL for this instance of the discord bot. For example, http://test.com:8123 (NOTE: The EXTERNAL PORT of the bot must be included at the end of the URL This is used to provide the linking URI to the capture, via the Direct Message the bot sends you when typing .au new (in conjunction with the PORT above). You must specify http:// or https:// accordingly as part of the URL

Default
http://au.yourdomain.com:8123
CONFIG_PATHPathrw,slave

Container Path: /config

Target
/config
Value
/mnt/user/appdata/amongusdiscord/
DISCORD_BOT_TOKEN_2Variable

(Optional) A second Bot Token to be used to distribute the mute/deafen requests to Discord. If you play in larger groups of 8+ people, this is recommended to not be rate-limited (delayed) by Discord when rounds change!

NUM_SHARDSVariable

How many total bot shard instances you'll be running in your current stack.

LOG_PATHPathrw,slave

The path where the bot will store it's log files

Target
/config/log_path
Value
/mnt/user/appdata/amongusdiscord/log_path