Frau is a Discord bot that allows scripts written in Python to be run in a Discord server.
Scripts are chat messages which include code segments in markdown (` and ```). The syntax highlighting setting of the code blocks does not matter. Scripts must also begin with #!frau and a newline to be valid Frau scripts. Scripts are saved in a single directory (%PYTHONPATH%) and each script has its own working directory during execution. Code is automatically executed after being recieved by Frau, and can be started and stopped using her commands.
Commands are invoked by tagging the bot in a message (@Frau command arg1 arg2 ...). Frau currently offers only a few basic commands to control script execution:
| Command | Description |
|---|---|
| start (script-name) | Starts a previously saved script |
| stop (script-name) | Stops a currently running script |
| stopall | Stops all currently running scripts |
| list | Lists all currently running scripts |
| send (script) (command) | Sends a message to a running script |
Services are scripts that run continuously. This is theoretically useful for creating scripts to handle general chat messages. Technically all scripts are run as services, but only scripts with the #$service=true option set will have chat redirected to their stdin. A service should loop infinitely and read stdin to handle Frau command packet things as they are sent. There are three service commands at this time:
#!frau-stop - Sent before the bot shuts down.
#!frau-command (command...) - Sent by the bot's 'send' command.
#!frau-chat (author) (author-name) (guild) (message...) - Sent to communicate a chat message.
Script metadata consists of the comment tags at the beginning of each file (#$var=value). These tags are processed before script execution and facilitate functionality including the naming of scripts and defining if scripts are services.
| Option | Value Type | Description |
|---|---|---|
| name | Text | Defines the name a script will be saved with |
| service | true/false | Defines whether or not to redirect chat to a script |
Frau is very much a work-in-progress since her its model for running scripts is highly insecure, as it has no means for controlling filesystem access. There is pretty much room for improvement everywhere.
Feel free to fork and make improvements as you like. It needs them.
General TODO:
- Make script execution secure. (Limit script file IO to their working directory.)
- Come up with a real method for saving and organizing scripts.
- Combining both of the above: Make Frau separate scripts between guilds/channels/user as appropriate.
- Make the Discord API fully available to scripts and fix services.
- Beautify all of the process interop stuff (ScriptService, etc).
- Better editing?
- Maybe implement
helpas some sort of loosely-coded chatbot?
======
