Admin Usage

Installing

If you want to host your own version of the bot, please refer to the install guide.
Else you can invite the bot via: Discord Invite

Bot Permissions

In all event channels the bot should has the permissions:

• Send Messages
• Read Messages
• Read Message History
• Manage Messages
• Manage Roles

Configuration

After the bot joined, only users with the admin permission can configure the bot.

Admin Role

Command: setAdminRole [role name]

Use this command to define a role, which grants access to all commands described in this section. Per default, only users with the admin permission have access to this commands.

---

Moderator Role

Command: setModeratorRole [role name]

Use this command to define a role, which grants permission to create and manage events. Per default, only users with the admin permission have access to this commands.

---

Event-Type Config

Command: setTypeConfig [channel suffix] [required role name] [opt: newbie role name] [opt: soft <True|False>]

This command can limit the access to a event type by user roles.

• The type identifier is the channel name suffix, so the last word of the channel name is used. o for example in the case of the channel name: '2021-12-24-arma3', 'arma3' would be the suffix.
• The required role, is the role which is required to join the event.
• The newbie role, is the role, which is given to all users, which try to join the event but don't have the required role.
• The soft option can be set to True, if a newbie role was given. If set to True, the required role is not necessary to join, but all users, which don't have the required role, are given the newbie role when they join.

View Config

Command: viewConfig

Displays the bot config of this guild.

Event Creation

1. Choose a suitable channel or create a new one, but every Event needs its own channel.
2. Create a message containing a slotlist with the following rules:
   • Begins with the string >Slotlist<
   • A slot is defined with the format #[Number] [Slot Description] - [optional: Username]
   • Every slot has its own line
3. Send the message containing the slotlist
4. Use the create command to initialize the slotlist.

Advice

• Don't use dashes in the slot description
• You can use leading zeros for the slot numbers
• Discord only supports a message length of maximum 2000 chars. Please make sure you don't exceed this limits, when creating the slotlist.

Example Slotlist

>Slotlist<

__Team Red__

**Chalupa One**
#01 Captain - Wasserstoff
#02 Gunner - 

**Chalupa Two**
#03 Captain -
#04 Gunner -


__Team Blue__
**Brigantine**
#05 Captain -
#06 Gunner -
#07 Gunner -
#08 Repairmen -

Event Management

How the Bot sees the Slotlist

For the bot the slotlist is a list of (slot)-groups, which have the properties:

• Title
• Number of line breaks before the group
• A list of slots

But these are all optional, so every slot belongs to a group (even without a title), but a title without slots is also considered as a group.

Manage Slots

Command	Arguments	Description
forceSlot	[slot number] [user name]	Registers a username for the given slot. The username argument, doesn't have to be a username
forceUnslot	[user name]	Withdraws a given user from the event
editSlot	[slot number] [description]	Edits the description of a slot given by its number
addSlot	[slot number] [group] [description]	Adds a new slot to a slot-group given by its title or index (counting from 0) If you want to refer to the group by its title and the title contains white-spaces you have to use quotation marks around the group argument.
delSlot	[slot number]	Deletes a slot given by its number

Manage Groups

Command	Arguments	Description
addGroup	[index] [title]	Adds a new slot-group. The index argument, defines where the slot-group is placed in the order of the existing slot-groups (counting from 0)
editGroup	[group] [new title]	Edits a slot-group name identified by its name or index (counting from 0). A new line in the name can be added with \n.
delGroup	[group]	Deletes a slot-group identified by its name or index (counting from 0). All slots of the slot-group are also deleted