4ba7062176
* feat(examples/*): add readme Add README.md to all examples. * fix(examples): logo image link * fix(examples): add fixed width to logo * feat(examples): add titles * fix(examples/*): make logo smaller Make DiscordGo logo smaller to match description and title in size. * fix(examples/avatar): correct avatar url Use correct logo URL in avatar URL image example. * fix(examples/slash_commands): wording Fix wording of "step-by-step tutorial" note.
39 lines
943 B
Markdown
39 lines
943 B
Markdown
<img align="right" alt="DiscordGo logo" src="/docs/img/discordgo.svg" width="200">
|
|
|
|
## DiscordGo Auto Moderation Example
|
|
|
|
This example demonstrates how to utilize DiscordGo to manage auto moderation
|
|
rules and triggers.
|
|
|
|
**Join [Discord Gophers](https://discord.gg/0f1SbxBZjYoCtNPP)
|
|
Discord chat channel for support.**
|
|
|
|
### Build
|
|
|
|
This assumes you already have a working Go environment setup and that
|
|
DiscordGo is correctly installed on your system.
|
|
|
|
From within the auto_moderation example folder, run the below command to compile the
|
|
example.
|
|
|
|
```sh
|
|
go build
|
|
```
|
|
|
|
### Usage
|
|
|
|
```
|
|
Usage of auto_moderation:
|
|
-channel string
|
|
ID of the testing channel
|
|
-guild string
|
|
ID of the testing guild
|
|
-token string
|
|
Bot authorization token
|
|
```
|
|
|
|
The below example shows how to start the bot from the auto_moderation example folder.
|
|
|
|
```sh
|
|
./auto_moderation -channel YOUR_TESTING_CHANNEL -guild YOUR_TESTING_GUILD -token YOUR_BOT_TOKEN
|
|
```
|