From ae2bb9467bb637dd71adaaa0c2b8a1c3cf4ac9bf Mon Sep 17 00:00:00 2001 From: Skylar Grant Date: Fri, 27 Jan 2023 23:41:04 -0500 Subject: [PATCH] Documentation Time --- README.md | 3 +++ data/CommandsRaw.md | 1 + data/strings.json | 4 ++-- package.json | 2 +- 4 files changed, 7 insertions(+), 3 deletions(-) create mode 100644 data/CommandsRaw.md diff --git a/README.md b/README.md index 0abea42..13fddf4 100644 --- a/README.md +++ b/README.md @@ -24,5 +24,8 @@ Silvanus requires permissions to `Send Messages` and `Send Messages in Threads` * `/setupinfo` - Displays links to the current Tree and Tallest Trees messages configured in your server. * `/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 (`[+]`) and a water wait time calculation (`[20 mins]`) * `/watertime height` - 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`. +* `/setping` - Guild members with the `Manage Roles` permission can run this command to set a Ready to Water reminder meaage and set the channel to send it in. Once this command has been run a new `Reset Ping` button will appear next time you refresh the `/compare` message. +* `/optout` - Disable automatic water reminder messages. * `/reset` - Removes your server's configuration from the database. * `/help` - Displays the bot's help page and links to each command. \ No newline at end of file diff --git a/data/CommandsRaw.md b/data/CommandsRaw.md new file mode 100644 index 0000000..6492438 --- /dev/null +++ b/data/CommandsRaw.md @@ -0,0 +1 @@ +"**Commands**\n - Automatically detects and saves the location of your server's Tree and Tallest Trees messages. Run this command in the channel(s) that contain these messages.\n - Displays links to the current Tree and Tallest Trees messages configured in your server.\n - 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 (`[+]`) and a water wait time calculation (`[20 mins]`)\n - Calculates the wait time between waters for a tree of a given height.\n - Calculates how long it would take to go from `beginheight` to `endheight`.\n - Guild members with the `Manage Roles` permission can run this command to set a Ready to Water reminder meaage and set the channel to send it in. Once this command has been run a new `Reset Ping` button will appear next time you refresh the `/compare` message.\n - Disable automatic water reminder messages.\n - Removes your server's configuration from the database.\n - Displays the bot's help page and links to each command." \ No newline at end of file diff --git a/data/strings.json b/data/strings.json index 8aa5de8..6365cab 100644 --- a/data/strings.json +++ b/data/strings.json @@ -4,10 +4,10 @@ }, "help": { "title": "Silvanus Help", - "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! Get started with and , then check out .\n\nImportant Note: Silvanus is only as up-to-date as your server's Tree and Tallest Trees messages. Make sure to refresh them before refreshing Silvanus' Compare message.\n\nFor the best experience we recommend the use of a single and message, otherwise make sure to run each time you run .\nStatus Indicator: ``[ Active Growth Indicator: 💧 | 24 Hour Observed Growth | Wait Time Between Waters ]``", + "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! Get started with and , then check out .\n\nImportant Note: Silvanus is only as up-to-date as your server's Tree and Tallest Trees messages. Make sure to refresh them before refreshing Silvanus' Compare message.\n\nFor the best experience we recommend the use of a single and message, otherwise make sure to run each time you run .", "setup": "To begin analyzing your Tree, first you must set up the reference messages.\n\n1. Run in the channel(s) that contain your server's tree and leaderboard messages.\n2. Now simply run where you want your analysis to be visible.", "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": " | | | | | " + "allCommands": " - Automatically detects and saves the location of your server's Tree and Tallest Trees messages. Run this command in the channel(s) that contain these messages.\n - Displays links to the current Tree and Tallest Trees messages configured in your server.\n - 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 (`[+]`) and a water wait time calculation (`[20 mins]`)\n - Calculates the wait time between waters for a tree of a given height.\n - Calculates how long it would take to go from `beginheight` to `endheight`.\n - Guild members with the `Manage Roles` permission can run this command to set a Ready to Water reminder meaage and set the channel to send it in. Once this command has been run a new `Reset Ping` button will appear next time you refresh the `/compare` message.\n - Disable automatic water reminder messages.\n - Removes your server's configuration from the database.\n - Displays the bot's help page and links to each command." }, "commands": { "compare": "", diff --git a/package.json b/package.json index 230e459..f749387 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "silvanus", - "version": "1.1.3", + "version": "1.1.4", "description": "Grow A Tree Comparison Tool", "main": "main.js", "scripts": {