Skip to content

Commit 31f3f14

Browse files
committed
Add documentation and license.
1 parent a2f716b commit 31f3f14

3 files changed

Lines changed: 54 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Penple
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# FungusBot
2+
3+
FungusBot is a [Discord](https://discord.com/) bot designed to streamline [Among Us](http://www.innersloth.com/gameAmongUs.php) games by completely automatically muting/deafening Discord users based on their status in game.
4+
5+
## Installation
6+
7+
1. Download the latest release of FungusBot from GitHub.
8+
2. Download and place the [config.json](config.json) in the same directory as the FungusBot.exe binary.
9+
3. Modify config.json with your discord bot token and the ID of your guild and voice channel that you would like controlled.
10+
4. Start Among Us and start FungusBot.exe.
11+
12+
## Usage
13+
14+
FungusBot is able to automatically mute and deafen users in the configured voice channel automatically as the game progresses.
15+
In-game players will be deafened to allow for the dead players to speak to each other, and will not be undeafened/unmuted until the next meeting is called (to prevent players from using others voice status to cheat).
16+
17+
Discord users must have the exact same discord username or nickname as their name within the game.
18+
19+
FungusBot can not yet detect when games end.
20+
`!end` may be used during the win screen to undeafen everyone in the channel.
21+
22+
`!start` can also be used to re-deafen everyone if necessary.
23+
24+
Users that do not have a username that is the same as one in game will not be controlled by the bot.
25+
26+
## How does it work?
27+
28+
FungusBot reads the memory of Among Us to detect several components of the game state. This is more reliable than other methods of reading game state such as OCR. Unfortunately it also means that new memory addresses will have to be found after every game update.

config.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
3+
"guild": 111111111111111111,
4+
"channel": 111111111111111111
5+
}

0 commit comments

Comments
 (0)