ssube
/
taleweave-ai
1
0
Fork 0
Code Actions

explain rendering events in discord

This commit is contained in:
Sean Sube 2024-06-03 22:49:34 -05:00
parent 2d43b44ac0
commit d5fdb0bda6
Signed by: ssube
GPG Key ID: 3EED7B957D362AF1
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/guides/player.md
View File

@ -4,11 +4,15 @@
- [Player's Guide to TaleWeave AI](#players-guide-to-taleweave-ai) - [Player's Guide to TaleWeave AI](#players-guide-to-taleweave-ai)
- [Contents](#contents) - [Contents](#contents)
- [Discord Command Syntax](#discord-command-syntax) - [Playing in Discord](#playing-in-discord)
- [Prompt Syntax](#prompt-syntax) - [Discord command syntax](#discord-command-syntax)
- [Prompt Function Syntax](#prompt-function-syntax) - [Rendering events in Discord](#rendering-events-in-discord)
- [Prompt syntax](#prompt-syntax)
- [Prompt action syntax](#prompt-action-syntax)
## Discord Command Syntax ## Playing in Discord
### Discord command syntax
*Note 1:* Because TaleWeave AI offers a dynamic set of actions depending on the game world, it does not currently use *Note 1:* Because TaleWeave AI offers a dynamic set of actions depending on the game world, it does not currently use
Discord's command feature. If you know a way to make this work with constantly-changing actions, please let me know. Discord's command feature. If you know a way to make this work with constantly-changing actions, please let me know.
@ -34,11 +38,20 @@ The Discord bot offers the following commands:
Other messages will be treated as in-character input and used as your character's action or reply, depending on the Other messages will be treated as in-character input and used as your character's action or reply, depending on the
current prompt. current prompt.
## Prompt Syntax ### Rendering events in Discord
The web client displays a menu with all of the available actions on your turn, but you can also input your own actions. You can render recent events in Discord by reacting to them with the camera emoji: 📷
### Prompt Function Syntax If the bot can render that event, it will acknowledge your request with the camera flash emoji: 📸
When the images are ready, they will be posted to Discord as a reply to the event message.
## Prompt syntax
The web client displays a menu with all of the available actions on your turn, but you can also input your own actions
through text.
### Prompt action syntax
In order to call functions or use actions from your prompt replies, you (or more likely your GUI) can send valid JSON, In order to call functions or use actions from your prompt replies, you (or more likely your GUI) can send valid JSON,
or you can use this prompt function syntax. Discord and the web client both support this syntax. or you can use this prompt function syntax. Discord and the web client both support this syntax.