Help & setup
Adding Mjerg takes about ten seconds. Getting it set up the way you want takes about five minutes, and you only ever do it once.
Adding Mjerg
There is no invite link. Osmium handles this inside the app:
-
Open Osmium
Desktop, web or mobile. It's the same flow on all three.
-
Click on Mjerg
Search for it, or click the bot's name anywhere you've seen it post. That opens its profile.
-
Hit "Add to Chat"
Choose the community, confirm the permissions, and Mjerg joins.
You need Manage community in the target community to add any bot. If the button doesn't do anything, that's almost always why. Ask whoever owns the community to do it.
The four things worth setting first
Mjerg works immediately with no configuration, but these four make the difference between "a bot is here" and "the bot is useful". All of them need Manage community.
Channels and roles are given as IDs, not mentions. Typing
#mod-log or @Moderator won't work.
!roles lists every role in the community with
its ID next to it, and channel IDs are copied from Osmium itself —
open the channel's menu and copy the ID.
-
Point the log channel somewhere
Copy your mod-log channel's ID out of Osmium, then
!channel logfollowed by that ID. Without this, moderation actions still happen but nothing gets written down, which defeats most of the point. -
Decide who counts as a manager
Run
!roles, find your moderator role, then!managerolewith its ID. That sets which role is allowed to change Mjerg's settings, separately from Osmium's own permissions. -
Turn on the automod rules you want
!automod invites on, and the same for the other rules. They're individually switchable so you can start with one and see how it goes. -
Greet people, or don't
!channel welcomewith a channel ID, then!welcometo write the greeting itself. Add!autorolewith a role ID if new members should pick up a role on join.
When you're done, !config prints every setting
for the community on one screen. It's the fastest way to spot the thing you
forgot.
Common questions
Mjerg isn't responding to anything
Three things, in order of likelihood. One: the prefix has been changed
in this community, so try @Mjerg help instead. Mentioning it
always works. Two: Mjerg can't see the channel, check its role has read
and send access there. Three: the command was disabled. If none of those
apply, !ping in a channel you know it can
see will tell you whether it's alive at all.
It won't take my #channel or @role
It won't, and that's expected. Mjerg takes IDs for channels and roles,
not mentions, so !managerole @Moderator
fails where the same command with the role's ID works.
!roles prints every role with its ID, and
channel IDs come from Osmium — open the channel's menu and copy the
ID. Members are the exception: !warn,
!ban and the rest take a normal mention.
Can I change the prefix?
Yes, per community. The default is !.
Mentioning the bot works regardless of what you set, so you can't lock
yourself out.
A moderation command says I don't have permission
Mjerg reads permissions from your Osmium roles rather than keeping its
own list. !ban needs Ban members,
!purge needs Manage messages, and so on. The
red tags on the commands page show which is
which. If you have the permission and it still refuses, Mjerg's own role
may sit below the member you're acting on.
How do I turn off levelling, or the economy, or the games?
Individually, with !disable on the
commands you don't want, or wholesale by leaving the relevant features
unconfigured. Nothing switches itself back on.
Someone's XP or balance is wrong
!setxp and
!setcoins both set values directly, and
!resetlevels wipes XP for one member or for
everyone. Resets aren't reversible, so double-check the argument before you
send it.
Does Mjerg read our messages?
It has to see message content to notice commands, count XP, run the counting game and apply automod rules. It doesn't store the text of ordinary messages, and nothing from your community is sold, shared or used for training. The info page lists exactly what gets written to disk.
Can I run my own copy?
Mjerg isn't open source right now. If you want to build something like
it, Osmium's API docs and the official
bot-example-js repo are a good place to start.
Something's broken and none of this covers it
The support community is the fastest route. Bug reports there usually get a look within a day or two. Include the command you ran and roughly when, it makes finding it in the logs much easier.