Server Config

Mouse Bot uses server config for most of the settings. Some settings are not configurable on a per server basis (ie., the points received per message). In order to get started, you can edit some of the settings in any channel on your server. To get this done, you'll use the following command structure:

/set edit <key-to-change> <new-value>

You can see all of the current settings by just using /set.

  1. Change the prefix if you want to. To do this type /set prefix <new-character>.

  2. Use the same command structure (but with your new prefix, if you changed it) to allow your moderators and administrators to use my higher level functions. Right now you're the only one who can probably change these things and use my other system commands.

    • /set modRole <your-moderator-role-name>

  3. Here's a list of other important settings you should consider changing. The key is listed with the system default value:

    • welcomeChannel: general
    • welcome: 0
    • points: 0
    • roleReward: 0 (will only work if points is 1)
    • guildReset: 0000 (based on EST, must be 24-hour time)

Now that you have everything configured to your server, use the help command to read more about what I can do. You can also check out my user manual for more in-depth details of my functions

The settings that can be changed per server are (defaults listed below):

"prefix": "/",
"modRole": "Mod",
"guildReset": 0000,
"points": 0,
"roleReward": 0,
"welcome": 0,
"welcomeChannel": "general",
"welcomeMessage": "Welcome to {{server}}, {{user}}! Please take a second to enter your swgoh.gg username by typing `{{prefix}}register <swgoh.gg-username>` (remember to remove \`< >\`). If you need any help, just type \`{{prefix}}help\`!"

These can be changed by using the set command. For more information on how to change these, read up on the command instruction.

Each configuration is explained below with the values it can be changed to.

prefix

This is the value used to invoke commands. It is required for a command to be called and must precede the name of the command without any spaces. The default value is / and this can be changed to any single character value.

welcomeChannel

By default this is sent to general. This is used very infrequently and only for small announcement (ie., when the prefix value is changed, Mouse Bot will send a message to the welcomeChannel notifying everyone of the change). This should be set to either the #general channel (or equivalent if the name has been changed) or an announcement channel. Do not include the # when changing this value.

modRole

This is the name of the role for moderators within your server. The default value is Mod and can be changed to any string value. Anyone with the role defined by modRole will be allowed to use any commands with the permission of moderator.

welcome

This toggles on/off the welcomeMessage. Accepted values are on to turn welcome messages on and off to turn them off.

points

This toggles on/off the points system. This can be turned on independently from the role rewards. User's will be notified when they level up by chatting and using commands. Accepted values are on to turn welcome messages on and off to turn them off.

roleReward

This toggles on/off the role rewards. If this is turned on, then the points system must also be enabled. Roles are rewarded after users accumulate a set amount of points and gain levels. Accepted values are on to turn welcome messages on and off to turn them off.

guildReset

This is the guild reset time which is based on server time zone (-0500 EST). You can convert your guild reset time into EST in order to use commands such as dalies.

welcomeMessage

This is the message that is displayed when a new user joins your server. This can be enabled or disabled with the welcome.

results matching ""

    No results matching ""