-
Notifications
You must be signed in to change notification settings - Fork 0
Feature Plugins
Feature plugins in Reywen are plugins that do things these include message, e6, bridge, plural and shell
Bridge 'bridges' the messages between two Revolt channels, unlike Automod's bridge this system is not usable on Discord and does not store a database of messages (so editing messages is impossible).
All that is required for bridge is to enable it, and set the two bridging channels in config/bridge.json
{
"enabled": false,
"channel_1": "",
"channel_2": ""
}E6 is a http utility for interacting with e621 and websites with an identical system. (e.g. e926)
Starting e6 simply requires the bot to be turned on, by default no NSFW is permitted through the bot but this can be overridden by changing the URL at config/e6.json.
{
"enabled": false,
"url": "https://e926.net"
}For now there is only one command for E6
?e search <query>
This will fetch the search result and send an embedded link.
Message is the oldest and most boring plugin, it handles normal bot commands and is the only plugin that is enabled by default config/message.json.
?mog will print out a mog emoji, but functionality can easily be extended by lengthening the match statement
Plural allows users to send messages using profiles defined in a mongodb instance. Currently there is no public mongodb server so any use outside of the offical Reywen bot will have to be self hosted
The command prefix is ?p, there are several commands related to the
search <name>: Search for an entry in mongodb
insert <name> <avatar-url> <color>: create a new entry
query <name>: searches for entry and provides details
send <name> <content>: sends message as a given entry
rm <name>: removes entry
{
"enabled": true,
"channel_only": false,
"channel": "",
"username": "
"password": "PASSWORD",
"ip": "localhost",
"port": "27017",
"database": "test"
}The last 5 options are for reywen's implementation of MongoDB, by default IP and port will default to localhost and 27017 (MongoDB's default port)
Shell plugin allows interaction between Revolt chat and a computers shell interface with non session based commands. Shell is very dangerous, it is recommended to limit shell to sudoers and a single restricted channel
Like most, shell is disabled by default (and is not running on the official server)
{
"enabled": false,
"whitelist_sudoers": true,
"channel_only": false,
"channel": ""
}The last 3 options are the security options as mentioned previously. It should be noted that Shell has the ability to remove the reywen binary, and if reywen is not containerized it is capable of much more.
Using shell is just like using a regular bash shell, with a few differences
namely text formatting can be a bit bugged.
run ?/ followed by the desired command.