discordmuffin/examples/dm_pingpong/README.md
Fedor Lapshin 4ba7062176
Add README.md to all examples (#1236)
* 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.
2022-11-09 22:19:23 +03:00

43 lines
1 KiB
Markdown

<img align="right" alt="DiscordGo logo" src="/docs/img/discordgo.svg" width="200">
## DiscordGo Direct Message Ping Pong Example
This example demonstrates how to utilize DiscordGo to create a Ping Pong Bot
that sends the response through Direct Message.
This Bot will respond to "ping" in any server it's in with "Pong!" in the
sender's DM.
**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 dm_pingpong example folder, run the below command to compile the
example.
```sh
go build
```
### Usage
This example uses bot tokens for authentication only. While user/password is
supported by DiscordGo, it is not recommended for bots.
```
./dm_pingpong --help
Usage of ./dm_pingpong:
-t string
Bot Token
```
The below example shows how to start the bot
```sh
./dm_pingpong -t YOUR_BOT_TOKEN
Bot is now running. Press CTRL-C to exit.
```