Skip to content
This repository has been archived by the owner on Jul 13, 2019. It is now read-only.

Getting Started

Jump to bottom
zekro edited this page Apr 1, 2018 · 3 revisions

Introduction

This is a quick guide how to set up the bot for your guild after invitation.

Little explaination about argument usage:

  • <name> → required argument
  • (<name>) → optional argument
  • -e <color> → optional arguments, that need identifier in front
  • <use mention/ID/name> → required argument, where mention, ID or name of a user can be used in this case

Channels

When the bot joins the guild, it creates automatically a categorie with the name zekroBot2 with three channels in it:

  • #commands
  • #voicelog
  • #cmdlog

The commands channel is just for seperating bot commands from default message channels. The channel voicelog is automatically connected to the oice log system, which logs all voice movement in the voice channels. The commands channel shows all entered commands on the guild.

Those channels can be renamed without problems and also deleted. But after deleting them, you need to set the new channels as voice log or command log channel.

Prefix

First, you should set a guild-specific prefix. This can be used on your guild to acces the bots commands. But still, the global prefix zb: will also work on the guild if a user does not know the guilds specific prefix.

The guild prefix can be set with the command:

zb:prefix <your prefix>

Permissions

Next, you should care about permissions and which rols on your guild should be able to use which commands. The system works like following:

Every command has a spcified permission level:

  • Lvl 0 → Commands accessable for everyone
  • Lvl 1 → Less moderatie commands
  • Lvl 2 → Moderative commands
  • Lvl 3 → More moderative commands
  • Lvl 4 → Less administrative commands
  • Lvl 5 → Guild administrative commands (only avainalbe for guild owner, if no other role specified on this permission level)

Which command has which permission level you can see using the help command:

zb:help

Now, you can set the Levels for roles you want with the following command:

zb:perms <lvl> <role1>, (<role2>), (<role3>) ...

Okay, take a look at the following example:

zb:perms 2 Moderator, Supporter
zb:perms 4 Admin

After that, all Members with the role Moderator or Supporter can access all comands with a permission level from 0 to 2 and every member with the role Admin can access commands with permission levels from 0 to 4.

Notification channel

You should set one channel as notification channel, where the bot will post messages like join messages, report, kick and ban logs and other notification messages which will be added soon.

Just enter the wanted text channel for this and enter the command

zb:msgchan

Now, the current text cahnnel is set as notification channel.

Alternatively, you can also use the channels name or ID to sset it as notification channel:

zb:msgchan <channel name/ID>
Clone this wiki locally