AmongUsBot
Shitty (but lightweight) bot that toggles server muting of all members in a specific user's voice channel when a hotkey is pressed. Uses the keyboard module to listen for keypresses.
If you are looking for the project with the same very original name that uses Tesseract and Selenium go here: https://github.com/alpharaoh/AmongUsBot
Installation
Clone the Repository and Install with Poetry (preferred)
git clone https://github.com/PederHA/AmongUsBot.git
cd amongusbot
poetry install
Install with pip (alternative)
pip install https://github.com/PederHA/AmongUsBot/releases/download/0.2.1/amongusbot-0.2.1.tar.gz
NOTE: The version on PyPi does not include sound alerts and example run file! Download those files manually and place them in your project root if you choose to use pip.
Running
Create a Bot User
Go to https://discord.com/developers/applications and create a new application, then add a bot user to the application by clicking on the "Bot" tab on the left-hand side of the page.
Invite the Bot to Your Server
Invite the bot with the following URL (substitute with your bot's ID):
https://discord.com/oauth2/authorize?client_id=<BOT_CLIENT_ID>&scope=bot&permissions=12651520
Run the Bot
See run_example.py.
Add the bot's secret token as an environment variable named AUBOT_TOKEN or pass it in as the first argument to the application when running it.
Configuration
amongusbot/config.py defines the following configuration options:
@dataclass
class Config:
user_id: int # ID of user to mute voice channel of
hotkey: str = "|" # Trigger hotkey
log_channel_id: Optional[int] = None # Log channel ID
poll_rate: float = 0.05 # Keyboard polling rate (seconds)
command_prefix: str = "-" # Command prefix
doubleclick: bool = False # Require double-click of hotkey to trigger
doubleclick_window: float = 0.5 # Double-click activation window (seconds)
cooldown: float = 2.0 # Trigger cooldown
sound: bool = False # Play sound when triggered
mute_sound: str = "audio/muted.wav" # Mute sound
unmute_sound: str = "audio/unmuted.wav" # Unmute sound
Defaults can be overridden when running the bot:
from amongusbot import run, Config
run("your_token", Config(user_id=123456, hotkey="f4"))
Usage
Press the hotkey whenever a round starts to mute everyone in your channel, and press it again whenever a meeting is convened or the game ends.
Notes
Only tested on Windows.
Metadata
Release files for amongusbot 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| amongusbot-0.2.1.tar.gz | 5.1 kB | Without provenance | Details for amongusbot-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| amongusbot-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for amongusbot-0.2.1-py3-none-any.whl |
Total release size: 10.9 kB
Release files / amongusbot-0.2.1.tar.gz
| Download URL | amongusbot-0.2.1.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cdcd78d9bfae6d11dfddd18d3f9bc818f3bc94f63c7d38e9797c3c015e902c25
|
|
BLAKE2b-256 checksum How to use checksums |
ed93296cc74b0898c0b3576bda35a5f841c06542b23f44cd1972e3110c8ea526
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.8.5 Windows/10
|
Release files / amongusbot-0.2.1-py3-none-any.whl
| Download URL | amongusbot-0.2.1-py3-none-any.whl |
|---|---|
| Size | 5.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3e14bbc70f4c2fa1ea2d512c30cd5a64cab746e9c7a79a2f808924636e50129e
|
|
BLAKE2b-256 checksum How to use checksums |
244545f36fc9c00bffdc9d274ac735307273cb2226ff62e2bb8e468835b2062f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.8.5 Windows/10
|
Security for amongusbot 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.