1 Silvanus Setup Guide
Skylar Grant edited this page 2023-09-01 18:20:01 -07:00

Silvanus Setup Guide

This guide will show you how to configure and use Silvanus' core features. Other features will be better documented in a future guide.

Notification Relay

Frustrated by notification spam from the official Grow A Tree bot? Learn how to set up Silvanus' Notification Relay for fully customizable, self-deleting notifications!

Setup

You should create a channel that is dedicated to receiving the notifications from Grow A Tree. I recommend that this channel is hidden from normal members to reduce clutter. I also recommend muting this channel and maybe hiding it at the bottom of the server list. Silvanus will watch this channel for notifications from Grow A Tree, then it'll relay those notifications with your customizations to the channel of your choosing. Silvanus' notifications auto-delete after half a second to reduce spam and clutter.

First, set up Grow A Trees official notifications. You'll need to give the Grow A Tree bot permission to Manage Webhooks. Use /notifications configure to enable the notifications, then use /notifications set-channel to finish setup.

Next, use Silvanus' /relay set command to configure your custom notifications.

  • watchchannel is the channel you created for the Grow A Tree notifications earlier.
  • watermessage is the message you want to be sent when your tree is ready to be watered. Include any relevant @Pings here.
  • pingchannel is the channel where you want Silvanus to send the notifications to. This would likely be your tree channel so waterers can get to the tree directly from the notification.
  • fruitmessage is optional, if you don't supply a fruit message the bot will use the same message you provided for watermessage

Now when your tree is dropping fruit or ready for watering, you'll receive your customized notifications!

Troubleshooting

If Silvanus' relay isn't working right, here are a few ways you can test it.

Server Administrators can use /setup view and /permissions to view the current server configuration and permissions within Silvanus.

Anyone can send a message with .ping and Silvanus will respond with "Pong!" If Silvanus doesn't respond then it doesn't have permission to send messages in that channel. Use this in your pingchannel to make sure Silvanus can send the notifications there.

You can also manually trigger a relay by sending "fruit ping" or "water ping" in the watchchannel and Silvanus will send a matching notification.

There is a bug with /relay update where changing the watchchannel causes the relay to be disabled. After changing the watchchannel, verify that the relay is still working with /setup view, if the Notification Relay Enabled says 1, it's enabled. If it says null then this bug has occurred. If it says 0 then it's been disabled via command.

Leaderboard Comparison

After Silvanus joins your server:

  1. Refresh your (or send a new) tree message
  2. Send (or refresh or change pages on) a /top trees message
  3. Run the /compare command and view the results

Note: When you change pages on the Top Trees message, Silvanus should automatically update the last-used Comparison message

Troubleshooting

If Silvanus has stopped updating your /compare message automatically, you may need to click on the refresh button below the message. Sometimes if it's been too long since it's been updated a new message will have to be sent.

This should be resolved but there was a bug where using /compare before setting anything else up will result in an error saying the bot can't find your tree or leaderboard messages. If this happens you can resolve this by using /relay set and putting any data in. You can disable the relay with /relay disable if you don't want the relay.

Role Menu

Interested in using Silvanus to give and take pingable roles for your tree?

  1. Run the /setup rolemenu command. Provide the roles in their respective spots (i.e. /setup rolemenu waterrole:@Water fruitrole:@Fruit)
  2. If the setup was successful Silvanus will reply with a preview of what the role menu will look like
  3. If the preview looks good, simply run /rolemenu wherever you want the role menu visible

Troubleshooting

  • Use /permissions to check that Silvanus has the necessary permissions.
  • Make sure that Silvanus is a member of a role that is higher in the role list than your Water and Fruit ping roles.

Example of incorrect role order:

Example of correct role order:

The first message is from the incorrect role order. Since Silvanus' role is below the @Water and @Fruit roles, it is unable to give or take those roles from other members. The second message shows a successful role removal under the correct ordering.