Skip to content

Commit a1ee769

Browse files
committed
Update README.md
1 parent 7f0f154 commit a1ee769

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

BOT_README.md

-2
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,3 @@
77
4. On the left panel, click "OAuth2", and then check the box marked `bot` under `Scopes`. Then scroll down to `Bot Permissions`, and check the box marked `Administrator` in the future, we will refine the permissions, but for now it is easiest with Admin permissions.
88

99
5. Scroll back up to `Scopes`, and copy the URL in the field that begins with `https://discord.com/api/oauth2/authorize?`. Paste this in a new browser tab, and grant the App access to whatever server you wish it to access. Close this tab when Finalized.
10-
11-
6. Last step, almost there! Now we need to get our discord Guild ID. Go to https://discord.com/app, and navigate to the Server you want the Bot to communicate in (Servers are also known as Guilds). Look at the URL in your browser. It will have the format `https://discord.com/channels/<DISCORD_GUILD_ID>/<DISCORD_CHANNEL_ID>`. Copy the `GUILD_ID` portion somewhere; we will need it later to configure the capture portion (`guildid.txt`).

README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1-
2-
3-
[![Build](https://github.com/denverquane/amongusdiscord/workflows/build/badge.svg)](https://github.com/denverquane/amongusdiscord/actions?query=build)
4-
5-
<img src="assets/botProfilePicture.jpg" width="128">
1+
<p align="center">
2+
<img src="assets/botProfilePicture.jpg" width="196">
3+
</p>
4+
5+
<p align="center">
6+
<a href="https://github.com/denverquane/amongusdiscord/actions?query=build" alt="Build Status">
7+
<img src="https://github.com/denverquane/amongusdiscord/workflows/build/badge.svg" />
8+
</a>
9+
<a href="https://github.com/denverquane/amongusdiscord/graphs/contributors" alt="Contributors">
10+
<img src="https://img.shields.io/github/contributors/denverquane/amongusdiscord" />
11+
</a>
12+
<a href="https://discord.gg/ZkqZSWF" alt="Contributors">
13+
<img src="https://img.shields.io/discord/754465589958803548?logo=discord" />
14+
</a>
15+
</p>
616

717
# AmongUsAutoMute (BETA)
818

@@ -61,7 +71,7 @@ Example:
6171
To start the bot in the current channel, type the following `.au` commands in Discord:
6272
```
6373
.au new ABCD eu
64-
# Starts a game, and allows users to add emojis to link to their in-game players
74+
# Starts a game, and allows users to react to emojis to link to their in-game players
6575
6676
.au t <voice channel name>
6777
# (Optional) This specifically marks the channel you want users automute within. Users in other voice channels will be ignored.
@@ -79,6 +89,7 @@ The Discord Bot uses the `.au` prefix for any commands
7989
|`.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`|
8090
|`.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`|
8191
|`.au link`|`.au l`|@name color|Manually link a discord user to their in-game color|`.au l @Soup cyan`|
92+
|`.au refresh`|`.au r`|None|Remake the bot's status message entirely, in case it ends up too far up in the chat.||
8293
|`.au end`|`.au e`|None|End the game entirely, and stop tracking players. Unmutes all and resets state||
8394
|`.au unlink`|`.au u`|@name|Manually unlink a player|`.au u @player`|
8495
|`.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)|

0 commit comments

Comments
 (0)