Getting Started
Introduction
This is a guide to help you install FroggeBot into your Discord server and
get started with the basic setup. A majority of the settings for FroggeBot are
intended to be "set-and-forget" and won't require further adjustments past the
initial setup.
Installation
Install Permissions
To install FroggeBot into your Discord server, you will need to have the
Manage Server permission in the server you wish to install the bot.
Installing FroggeBot is a simple process. You can invite the app to your server
by clicking the link below:
Invite FroggeBotApplication Permissions
Please note that FroggeBot requires the Administrator permission to function.
This is due to the wide range of features that the app offers and the permissions
required to manage them. We don't take this permission lightly and welcome all
questions regarding the proper use and distribution of permissions.
Integration Setup
Once you've invited FroggeBot to your server, you'll need to set up the app's
integration settings to ensure that only intended channels and roles can interact
with the app.
Step 1: Navigate
Your server's integration settings can be found by navigating to the
Server Settings menu and selecting the Integrations tab (underneath
the "Apps" header).
Locate FroggeBot in the list of integrations and click on the app's name
to open the integration settings.
Step 2: Adjust Permissions
In the integration settings, you can adjust the permissions for the app to restrict access to specific channels and roles. We recommend setting the app's permissions to only allow access to the channels and roles that you want the app to interact with. The following section outlines some common settings that you may want to consider.
Help! The Commands Are Displayed Twice!
If you see the app's commands being displayed twice in the integration menu,
don't panic. This is a known issue with Discord, which can arise occasionally
when registering global slash commands for the first time to an application
with the Administrator permission. Rest assured nothing is broken and the
duplicate commands will eventually fall off. In the meantime, it shouldn't
matter which set of commands you interact with.
Step 3: Suggested Settings
Remove the @everyone role from the app's permissions.
Grant access to the admin command subset to your server's administrators.
Grant access to the staff command subset to your server's staff members.
Grant access to the verify command for @everyone.
Configuring the Application
After you've set up the app's integration settings, you can begin configuring the app's global settings. The global settings are intended to be set once and left alone, as they control the app's behavior and functionality.
Configuration and setup commands can sometimes output a lot of chat spam. We recommend using a private channel to run these commands to avoid cluttering your server's chat. For our purposes, let's create a private channel called #lilypad where we can run these commands.
The /admin configuration command is used to configure
the app's global logging and timezone settings. Additionally,
the configuration for FroggeBot's /verify command can also be set here.
Log Channel
The channel where the app will post logs for various events. This should ideally be a private channel restricted to administrators and other management. Let's create one called #logs in the same category as #lilypad.
Click the button to select the channel.
Restrictions
Channel Type: Text Channel Only
(Please consult the Event Reference for a list of events that are logged.)
Timezone
The timezone that the app will use for all time-related commands and events. This should be set to the timezone of the server's primary audience. (EST by default)
For a list of supported timezones, please consult the Enum Reference.
Configure Verification Module
Here you can set the verification criteria, the role to assign to verified users, and any onboarding roles you want to transfer upon successful verification.
Check out the Verification Module for more information.
