Skip to content

Commit

Permalink
Added info about how to invite Sandpiper to your Discord server.
Browse files Browse the repository at this point in the history
  • Loading branch information
Phanabani committed Nov 2, 2020
1 parent 56a271c commit 2ddeba2
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The only value you need to set is the `bot_token`.

See [config](#config) for more configuration options.

### Running the bot
### Running Sandpiper

#### Basic

Expand All @@ -82,14 +82,28 @@ python -m sandpiper

[PM2](https://pm2.keymetrics.io/docs/usage/quick-start/) is a daemon process
manager. Ensure you've followed the virtual environment setup described above,
then simply run:
then simply run the following command in Sandpiper's root directory:

```shell script
pm2 start
```

This starts the process as a daemon using info from [ecosystem.config.js](ecosystem.config.js).

### Inviting Sandpiper to your Discord server

Sandpiper requires the following permissions to run normally:

- View Channels
- Send Messages
- Embed links

These correspond to the permission integer `19456`.

Sandpiper also requires the [server members privileged intent](https://discord.com/developers/docs/topics/gateway#privileged-intents)
to allow for Discord username/server nickname lookup in the `whois` command.
You can enable it on the bot page of your application (https:\//discord.com/developers/applications/<client_id>/bot).

## Config

Sandpiper can be configured with a JSON file at `./sandpiper/config.json`.
Expand Down

0 comments on commit 2ddeba2

Please sign in to comment.