Documentation update
This commit is contained in:
parent
2694d4b691
commit
f78caf4783
1
.gitignore
vendored
1
.gitignore
vendored
@ -7,6 +7,7 @@ env.prod
|
||||
.DS_Store
|
||||
data/guildInfo.json
|
||||
data/rawstring.txt
|
||||
modules/input.txt
|
||||
|
||||
# Custom folders
|
||||
# gifs/*
|
||||
|
23
README.md
23
README.md
@ -24,14 +24,23 @@ Silvanus requires permissions to `Send Messages` and `Send Messages in Threads`
|
||||
|
||||
## Commands
|
||||
* `/setup` - You only need to run this command if your server has its `/tree` and `/top trees` messages in separate channels.
|
||||
* `/setupinfo` - Displays links to the current Tree and Tallest Trees messages configured in your server.
|
||||
* `/setupinfo` - Displays your server's configuration information.
|
||||
* `/compare` - Sends a refreshable embed that calculcates the height difference between your tree and the trees currently displayed on your Tallest Trees message. There is also an Active Growth Indicator (`[💧]`).
|
||||
* `/setping` - Guild members with the `Manage Roles` permission can run this command to set up automatic reminders when your tree is ready to be watered.
|
||||
* Type a reminder message (including any `@pings` desired) and select a channel to send the reminders in.
|
||||
* Once this command has been run a new `Reset Ping` button will appear next time you refresh the `/compare` message.
|
||||
* Click the `Reset Ping` button to be sent a reminder the next time the tree is ready to be watered.
|
||||
* Use `/optout` to disable reminder messages for your server.
|
||||
* `/notifications` - Guild members with the `Manage Roles` permission can run this command to set up automatic reminders when your tree is ready to be watered or when fruit is dropping.
|
||||
* This feature relies on Grow A Tree's built-in Notification system. Refer to Grow A Tree for instructions on setting them up.
|
||||
* `watchchannel`: Select the channel you've configured Grow A Tree to send notifications in.
|
||||
* `watermessage`: This option sets the message to send when the tree is ready to be watered. This can include `@pings`, links, etc.
|
||||
* `pingchannel`: Select the channel you want Silvanus to forward the notifications to.
|
||||
* `fruitmessage`: Optional: This sets the message to send when the tree is dropping fruit. If not set, the `watermessage` will be used instead.
|
||||
* `/rolemenu` - Creates a menu for users to give themselves Water and Fruit pingable roles.
|
||||
* Requires `Manage Roles` permission to run.
|
||||
* `waterrole`: Select the role to give users when they select the Water button
|
||||
* `fruitrole`: Optional: Select the role to give users when they select the Fruit button
|
||||
* If this option isn't set, no Fruit Role will be available for self-assignment.
|
||||
* `/watertime` - Calculates the wait time between waters for a tree of a given height.
|
||||
* `/timetoheight` - Calculates how long it would take to go from `beginheight` to `endheight`.
|
||||
* `height`: The height in feet to calculate for.
|
||||
* `/timetoheight` - Calculates how long it would take to grow to a height
|
||||
* `endheight`: The destination height, in feet.
|
||||
* `beginheight`: Optional: The starting height, in feet. If this option isn't set, the current height of your tree will be used insead.
|
||||
* `/reset` - Removes your server's configuration from the database.
|
||||
* `/help` - Displays the bot's help page and links to each command.
|
@ -7,7 +7,7 @@
|
||||
"info": "Silvanus is the ultimate Grow A Tree companion bot! Quickly compare your server's tree to others on the leaderboard with automatic calculation of tree height differences, active growth detection, watering time calculations, and more!\n\nImportant Note: Silvanus is only as up-to-date as your server's newest Tree and Tallest Trees messages. Make sure to refresh them before refreshing Silvanus' Compare message.",
|
||||
"setup": "If your ``/tree`` and ``/top trees`` messages are in the same channel, simple run </compare:1065346941166297128> in that channel and you're good to go!\n\nOtherwise, run </setup:1065407649363005561> to set the proper channels for the bot to look in for the ``/tree`` and ``/top trees`` messages.\n\nUse </commands:1069501270454456331> to view a description of all my commands.",
|
||||
"permissions": "At a minimum, Silvanus requires permissions to `Send Messages` and `Send Messages in Threads` if applicable. If Analyzer is given permission to `Manage Messages`, the bot will delete the `.settree` and `.setranks` messages to reduce spam.",
|
||||
"allCommands": "</setup:1065407649363005561> - You only need to run this command if your server has its ``/tree`` and ``/top trees`` messages in separate channels.\n</setupinfo:1065413032374706196> - Displays links to the current Tree and Tallest Trees messages configured in your server.\n</compare:1065346941166297128> - Sends a refreshable embed that calculcates the height difference between your tree and the trees currently displayed on your Tallest Trees message. There is also an Active Growth Indicator (``[💧]``).\n</setping:1068373237995683902> - Guild members with the ``Manage Roles`` permission can run this command to set up automatic reminders when your tree is ready to be watered.\n Type a reminder message (including any ``@pings`` desired) and select a channel to send the reminders in.\n Once this command has been run a new ``Reset Ping`` button will appear next time you refresh the </compare:1065346941166297128> message.\n Click the ``Reset Ping`` button to be sent a reminder the next time the tree is ready to be watered.\n Use </optout:1068753032801693758> to disable reminder messages for your server.\n</watertime:1066970330029113444> - Calculates the wait time between waters for a tree of a given height.\n</timetoheight:1067727254634889227> - Calculates how long it would take to go from ``beginheight`` to ``endheight``.\n</reset:1065412317052944476> - Removes your server's configuration from the database.\n</help:1065346941166297129> - Displays the bot's help page and links to each command."
|
||||
"allCommands": "</setup:1065407649363005561> - You only need to run this command if your server has its ``/tree`` and ``/top trees`` messages in separate channels.\n</setupinfo:1065413032374706196> - Displays your server's configuration information.\n</compare:1065346941166297128> - Sends a refreshable embed that calculcates the height difference between your tree and the trees currently displayed on your Tallest Trees message. There is also an Active Growth Indicator (``[💧]``).\n</notifications:0> - Guild members with the ``Manage Roles`` permission can run this command to set up automatic reminders when your tree is ready to be watered or when fruit is dropping.\n This feature relies on Grow A Tree's built-in Notification system. Refer to Grow A Tree for instructions on setting them up.\n ``watchchannel``: Select the channel you've configured Grow A Tree to send notifications in.\n ``watermessage``: This option sets the message to send when the tree is ready to be watered. This can include ``@pings``, links, etc.\n ``pingchannel``: Select the channel you want Silvanus to forward the notifications to.\n ``fruitmessage``: Optional: This sets the message to send when the tree is dropping fruit. If not set, the ``watermessage`` will be used instead.\n</rolemenu:0> - Creates a menu for users to give themselves Water and Fruit pingable roles.\n Requires ``Manage Roles`` permission to run.\n ``waterrole``: Select the role to give users when they select the Water button\n ``fruitrole``: Optional: Select the role to give users when they select the Fruit button\n If this option isn't set, no Fruit Role will be available for self-assignment.\n</watertime:1066970330029113444> - Calculates the wait time between waters for a tree of a given height.\n ``height``: The height in feet to calculate for.\n</timetoheight:1067727254634889227> - Calculates how long it would take to grow to a height\n ``endheight``: The destination height, in feet.\n ``beginheight``: Optional: The starting height, in feet. If this option isn't set, the current height of your tree will be used insead.\n</reset:1065412317052944476> - Removes your server's configuration from the database.\n</help:1065346941166297129> - Displays the bot's help page and links to each command."
|
||||
},
|
||||
"commands": {
|
||||
"compare": "</compare:1065346941166297128>",
|
||||
|
@ -14,20 +14,21 @@
|
||||
|
||||
const fs = require('fs');
|
||||
const replaceAll = require('string.prototype.replaceall');
|
||||
const string = fs.readFileSync('./data/rawstring.txt').toString();
|
||||
const path = "./modules/input.txt";
|
||||
const string = fs.readFileSync(path).toString();
|
||||
let newString = replaceAll(string, '\* ', '');
|
||||
newString = replaceAll(newString, '\n', '\\n');
|
||||
newString = replaceAll(newString, '\r\n', '\\n');
|
||||
newString = replaceAll(newString, '\t', ' - ');
|
||||
newString = replaceAll(newString, '`/setup`', '</setup:1065407649363005561>');
|
||||
newString = replaceAll(newString, '`/setupinfo`', '</setupinfo:1065413032374706196>');
|
||||
newString = replaceAll(newString, '`/compare`', '</compare:1065346941166297128>');
|
||||
newString = replaceAll(newString, '`/setping`', '</setping:1068373237995683902>');
|
||||
newString = replaceAll(newString, '`/optout`', '</optout:1068753032801693758>');
|
||||
newString = replaceAll(newString, '`/watertime`', '</watertime:1066970330029113444>');
|
||||
newString = replaceAll(newString, '`/timetoheight`', '</timetoheight:1067727254634889227>');
|
||||
newString = replaceAll(newString, '`/reset`', '</reset:1065412317052944476>');
|
||||
newString = replaceAll(newString, '`/help`', '</help:1065346941166297129>');
|
||||
newString = replaceAll(newString, '`/commands`', '</commands:1069501270454456331>');
|
||||
newString = replaceAll(newString, '`/notifications`', '</notifications:0>');
|
||||
newString = replaceAll(newString, '`/rolemenu`', '</rolemenu:0>');
|
||||
newString = replaceAll(newString, '`', '``');
|
||||
fs.writeFileSync('./data/rawstring.txt', newString);
|
||||
fs.writeFileSync(path, newString);
|
||||
return "Done";
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "silvanus",
|
||||
"version": "1.1.5",
|
||||
"version": "1.2.1",
|
||||
"description": "Grow A Tree Companion Bot",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
|
Loading…
Reference in New Issue
Block a user