Getting Setup

Here's how you get setup with MaxBot!

Step 1: Adding MaxBot to your server

On any server giving you either powers of Administration or the Manage Server permission, you can add MaxBot using this link. You may be prompted to login to your Discord Account, but will then be given a choice of servers which you can add MaxBot. If the server you want to add MaxBot to isn't showing in this list, you do not have permission to add bots to that particular server.

Step 2: Semi-automatically generate Configuration Sectors using the MaxBot command handling service

That sounds really, really, complicated, doesn't it. But there isn't really anything involved. All you have to do is trigger a response from MaxBot, as it will then generate the configuration files it needs to use "Per-Server Personalisation" on your server, with "Per-Server Personalisation", you can change settings on your server without affecting other servers. If you don't set this up, and go to personalise something, MaxBot will generate these files for you, so you'll never accidently affect another server adversely, that's impossible!

You can trigger a response from MaxBot, by either:

• Running a command

• Using the prefix (mmbot/) with some random gibberish so MaxBot throws an error back at you.

• Using a command sort-of designed to start things off! (mmbot/online-check)

To generate these files, just run the following command in any channel, and MaxBot will generate these files for you:

mmbot/CreateConfigEntry

This command will generate all the files, and tell you that the operation has completed, and that you don't need to do that again. This command is designed for one-time and doesn't need to be run again thereafter.

*These files are created on the server used to host MaxBot, not your computer or phone!*

Step 3: Set the "Special Channels"

MaxBot will continuously remind you to do this until you actually do it!

It helps if you already have these three channels set up, but if you don't just create them!

Each of these channels is used in a different way: see how Special Channels are used.

How to set one of these channels

1. Get the ID of the channel you wish to set as the General channel. (You need to enable Developer mode, find out how to do that here.)

Navigate to the channel you use most commonly to talk about general, off-topic things, such as the weather or what not.

Right click on that channel in your channel selection list, and select "Copy ID" (the ID for that channel will be copied to the clipboard.

Select it as the General Channel for MaxBot by typing into any channel MaxBot can see:

mmbot/config general_channel_id==<paste your channel ID here>

Replace the <paste your channel ID here> with the channel ID, for instance:

This command will set the channel with ID 694303043432480807 as the General Channel.

To change the Admin and Console channels, repeat these steps however:

• To set the Admin Channel, replace general_channel_id with admin_channel_id

• To set the Console Channel, replace general_channel_id with console_channel_id

• To set the Rules channel, replace general_channel_id with induction_channel_id

• To set the Welcome/Leave messages channel, replace general_channel_id with leavejoin_channel_id

• To set the Admin Role ID, replace general_channel_id with admin_role_id

For more information on the Change-Config command, please see here.

Protip: It is best in most scenarios to create a private channel called #maxbot-console or similar to set as the console channel. Don't set the console channel ID to the ID of a general chat channel, as that will get very annoying!