Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: reword how to set Discord permissions slightly, to be less confusing #245

Merged
merged 1 commit into from
Jul 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,6 @@ This application logs in as a Discord bot to get a presence on Discord.
You have to create this bot yourself, by going to https://discord.com/developers/ and registering one.
The Discord token can be found under `Bot`.

After creating a bot, you need to invite this bot to your Discord channel.
If you are not the owner of that channel, you would need to make the bot `Public` before the admin can add it.
The bot needs at least `Send Messages`, `Read Messages` and `Manage Webhooks` permissions to operate in a channel.

Additionally, the bot uses the following intents:
- `messages`: to read messages.
- `guilds`: to read channel information.
Expand All @@ -97,6 +93,11 @@ Additionally, the bot uses the following intents:
Some of these intents need additional permission on the bot's side, under `Privileged Gateway Intents`.
Without those, this application will fail to start.

After creating a bot, you need to invite this bot to your Discord channel.
If you are not the owner of that channel, you would need to make the bot `Public` before the admin can add it.
The bot needs at least `Send Messages`, `Read Messages` and `Manage Webhooks` permissions on the Discord server channel.
These permissions need to be assigned on the Discord server itself, by someone with sufficient permissions to do so.

### IRC Puppet IP Range

The more complicated setting in this row is `--irc-puppet-ip-range`, and needs some explaining.
Expand Down