discordmuffin/examples/modals/README.md
guangwu c2117695cc
fix: typo in modal example and getting started (#1443)
Signed-off-by: guoguangwu <guoguangwu@magic-shield.com>
2023-09-04 21:42:02 +03:00

45 lines
1.1 KiB
Markdown

<img align="right" alt="DiscordGo logo" src="/docs/img/discordgo.svg" width="200">
## DiscordGo Modals Example
This example demonstrates how to utilize DiscordGo to send and process text
inputs in modals. If you have not read `slash_commands` and `components`
examples yet it is recommended to do so before proceeding. As this example
is built using interactions and Slash Commands.
**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 modals example folder, run the below command to compile the
example.
```sh
go build
```
### Usage
```
Usage of modals:
-app string
Application ID
-cleanup
Cleanup of commands (default true)
-guild string
Test guild ID
-results string
Channel where send survey results to
-token string
Bot access token
```
The below example shows how to start the bot from the modals example folder.
```sh
./modals -app YOUR_APPLICATION_ID -guild YOUR_TESTING_GUILD -results YOUR_TESTING_CHANNEL -token YOUR_BOT_TOKEN
```