rishav394 / amongusdiscord

Discord Bot to automute Among Us players at round transitions, in conjunction with denverquane/amonguscapture

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AmongUsAutoMute (BETA)

Discord Bot to scrape Among Us on-screen 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!

Requirements

  1. This program must be run on a Windows PC. The program CANNOT be run directly on mobile phones.
  2. You need a minimum of 12 open emoji slots on your server. The bot uses player emojis to link discord users to in-game player colors; it will add them automatically, but you need at least 12 slots (25 recommended).
  3. You must run the discord bot, and the capture portion (See Easiest installation below) at the same time, and on the same PC (for now).

Installation Video (click the image):

Made by Wolfhound905 for the pre-release! :)

Installation

Installation

If you followed all the steps in the video above, you're done with the installation and can start using the bot, or see the Usage/Commands sections below! If you prefer text instructions over videos, follow all the instructions below instead.

Pre-Installation Steps, Important!!!

  1. Create an Application and Bot account for your Discord Server (requires Admin privileges on the Server in question).
    • Follow the instructions HERE

Now follow either the Easiest install, or the Install From Source:

Easiest:

  1. Download the latest release executable (.exe) and final.txt for this discord bot.
  2. Paste the Bot Token you obtained in the pre-installation into the final.txt file, after the = sign.
  3. Run the executable from step 1, either by double-clicking or using ./amongusdiscord.exe in a terminal window.
  4. Download the latest amonguscapture.exe. If you are running the Discord bot remotely, you can add a host.txt file in the same folder with the contents http://<host>:<port> to point to that instance, but this is totally optional.
  5. If Among Us is already running, then start the capture executable you downloaded in the previous step. Otherwise, start the game and then start the capture.

Congrats, if you followed the instructions correctly, the bot should now be running! See the Sample Usage section below for details.

Install From Source:

  1. Install Go 1.15.2, but any version of Go 1.12+ should work.
  2. Clone the repository using git clone https://github.com/denverquane/amongusdiscord.
  3. Navigate to the directory with cd amongusdiscord, and then build the executable using go build -o amongusdiscord.exe main.go.
  4. Proceed to steps 2-3 of the Easiest install section above.

Docker

You can also run the discord portion using docker if you prefer, it simply needs the port 8123 exposed, and you should provide your DISCORD_BOT_TOKEN as an env variable. Example: docker run -p 8123:8123 -e DISCORD_BOT_TOKEN=<YourTokenHere> denverquane/amongusdiscord

Sample Usage

To start the bot in the current channel, type the following .au commands in Discord:

.au new ABCD eu
# Starts a game, and allows users to react to emojis to link to their in-game players

.au t <voice channel name> 
# (Optional) This specifically marks the channel you want users automute within. Users in other voice channels will be ignored.

Get Playing!

If you need to add more players to the tracking list, they can be added using the reaction emojis once back in the lobby. Or, manually using .au link @player color. If all else fails, you can start a new game with .au new.

Bot Commands

The Discord Bot uses the .au prefix for any commands

Command Alias Arguments Description Example
.au help .au h None Print help info and command usage
.au new .au n None Start a new game in the current text channel. Optionally accepts the room code and region .au n CODE eu
.au track .au t VC Name Tell Bot to use a single voice channel for mute/unmute, and ignore any other channels .au t Test Voice
.au link .au l @name color Manually link a discord user to their in-game color .au l @Soup cyan
.au refresh .au r None Remake the bot's status message entirely, in case it ends up too far up in the chat.
.au end .au e None End the game entirely, and stop tracking players. Unmutes all and resets state
.au unlink .au u @name Manually unlink a player .au u @player
.au force .au f stage Force a transition to a stage if you encounter a problem in the state .au f task or .au f d(discuss)

Similar Projects

  • 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 great program for tracking player status and auto mute/unmute in Among Us. Their project works like a traditional Discord bot; very easy installation!

Troubleshooting

About

Discord Bot to automute Among Us players at round transitions, in conjunction with denverquane/amonguscapture

License:MIT License


Languages

Language:Go 99.1%Language:Dockerfile 0.9%