Silvanus is a companion bot for Limbo Labs' Grow A Tree bot https://silvanus.vfsh.dev

Go to file

Skylar Grant f78caf4783 Documentation update		2023-02-12 18:03:23 -05:00
.github/workflows	Fix CI for new env vars	2023-02-12 00:00:30 -05:00
data	Documentation update	2023-02-12 18:03:23 -05:00
modules	Documentation update	2023-02-12 18:03:23 -05:00
slash-commands	Tentative deploy	2023-02-12 17:16:03 -05:00
.dockerignore	Initial Commit	2023-01-17 19:35:24 -05:00
.DS_Store	Revert "Pull from treeanalyzer"	2023-01-21 09:58:32 -05:00
.eslintrc.json	Initial Commit	2023-01-17 19:35:24 -05:00
.gitignore	Documentation update	2023-02-12 18:03:23 -05:00
Dockerfile	Use node 18	2023-01-23 17:11:01 -05:00
main.js	Fixes, ready for testing	2023-02-12 16:00:04 -05:00
package.json	Documentation update	2023-02-12 18:03:23 -05:00
README.md	Documentation update	2023-02-12 18:03:23 -05:00
TODO.md	Dev-v1.1.4 (#9 )	2023-01-31 22:51:10 -05:00

README.md

Silvanus

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!

Important 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.

Silvanus is not affiliated with Grow A Tree or Limbo Labs.

Add Silvanus to your server

Invite Silvanus to your Discord Server

voidf1sh Development Support Server

Join Discord Server

Setup

If your /tree and /top trees messages are in the same channel, simple run /compare in that channel and you're good to go!

Otherwise, run /setup to set the proper channels for the bot to look in for the /tree and /top trees messages.

Use /commands to view a description of all my commands.

Permissions

Silvanus requires permissions to Send Messages and Send Messages in Threads if applicable.

Commands

/setup - You only need to run this command if your server has its /tree and /top trees messages in separate channels.
/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 ([💧]).
/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.
- 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.