discordmuffin/examples/airhorn/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

51 lines
1.3 KiB
Markdown

<img align="right" alt="DiscordGo logo" src="/docs/img/discordgo.svg" width="200">
## DiscordGo Airhorn Example
This example demonstrates how to utilize DiscordGo to listen for an !airhorn
command in a channel and then play a sound to that user's current voice channel.
**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 airhorn example folder, run the below command to compile the
example.
```sh
go build
```
### Usage
```
Usage of ./airhorn:
-t string
Bot Token
```
The below example shows how to start the bot from the airhorn example folder.
```sh
./airhorn -t YOUR_BOT_TOKEN
```
### Creating sounds
Airhorn bot uses [DCA](https://github.com/bwmarrin/dca) files, which are
pre-computed files that are easy to send to Discord.
If you would like to create your own DCA files, please use:
* [dca-rs](https://github.com/nstafie/dca-rs)
See the below example of creating a DCA file from a WAV file. This also works
with MP3, FLAC, and many other file formats. Of course, you will need to
[install](https://github.com/nstafie/dca-rs#installation) dca-rs first :)
```sh
./dca-rs -i <input wav file> --raw > <output file>
```