Getting started
From an empty server to a working bot, in the order it actually goes.
Arklynn works the moment it joins. Nothing below is required - every module is off until you turn it on, and the bot will not post anything in your server until you ask it to. Read this page once and you will know where everything is.
Step by step
- 1Invite the bot from arklynn.xyz. Keep the permissions the invite link asks for - they are the ones the modules need, and removing them now means coming back to this page when something silently does nothing.
- 2Open Server Settings → Roles in Discord and drag the Arklynn role above every role it will have to manage. A bot cannot touch a role that sits above its own, no matter what permissions it has. This one thing causes more "it is broken" reports than everything else combined.
- 3Type .help in any channel. If the bot answers, it can see and write in that channel and you are done with setup.
- 4Turn on the anti-nuke first: /antinuke toggle on. It is free, it costs nothing to run, and it is the only module whose absence you notice too late.
- 5Then pick what your server actually needs. Welcome messages and leveling are what most servers add next; the rest can wait until somebody asks for it.
If the bot answers .help but a module does nothing, the cause is almost always the role position from step 2, or a channel permission overwrite on the specific channel. Check those two before anything else.
Two ways to run everything
Almost every command exists twice: as a slash command you pick from Discord's menu, and as a prefix command you type. They do the same thing and share the same settings - there is no "slash version" of your configuration.
| Form | Looks like | When it is better |
|---|---|---|
/antinuke status | Slash command | You do not remember the options. Discord shows them as you type, and will not let you send something malformed. |
.antinuke status | Prefix command | You already know what you want. Shorter, and it works in a channel where slash commands are restricted. |
@Arklynn status | Mention | Somebody changed the prefix and nobody remembers to what. Mentioning the bot always works. |
The default prefix is a dot. Some commands are prefix-only and some are slash-only, usually because of what Discord allows - a command that has to open a form needs to be a slash command. Where that is the case, the page for that module says so.
Doing it from the website instead
Every module on this list can also be set up at arklynn.xyz/dashboard, which is the same settings through a form instead of a command. Sign in with Discord, pick the server, and the modules appear down the left. You need Manage Server on that server to open it.
- Changes save straight to the bot - there is no "apply" step and no delay to wait out.
- A green dot next to a module means it is set up. Modules that are running sort to the top, so the three you use are not below thirteen you do not.
- Some things only exist on the website: the embed editor with a live preview, the ticket panel builder, and the voice channel controls.
- Some things only exist in Discord: anything that has to react to a message you are looking at, and the first-time ticket setup.