Docs
Everything you need to set RuneClan Bot up and use it day to day.
Getting started
- Add RuneClan Bot to your server (you need Manage Server there).
- Open the Bot Dashboard, sign in with Discord and pick your server.
- Start the Setup guide from Settings. Quick asks a few yes or no questions and just the details each part needs. Full goes through every option. Custom lets you tick the parts first.
- Start with the admin roles: nothing is set up for you, so you choose what the bot does and for whom.
The guide starts from what is already set, so you can leave and pick it up later or run it again to change one part.
Who can use the dashboard
- The server owner, anyone with the Administrator or Manage Server permission, and anyone with a role in the server's Admin group.
- People in the Developer group can open it with a limited view.
- It is checked against your server's roles on every click, so removing someone's role removes their access immediately.
The dashboard
- Overview. Is the bot healthy, how many members are linked, open tickets, signups and polls, and what is set up. A checkup card tells you if anything needs fixing, and any notice about a known issue shows at the top.
- Server setup. The basics: your clan, where link requests are reviewed and the roles members get. Each section opens and closes, and a bar at the bottom saves everything and warns you about unsaved changes.
- Roles & permissions. Who counts as Admin, Support and Developer, and your own groups of roles. Commands can be limited to these groups.
- Guided setup. A step-by-step run through the parts of RuneClan Bot: Quick, Full or Custom. It starts from what is already set, so you can leave and pick it up later.
- Commands. Turn each command on or off, choose who may use it and in which channels. Search and filter the list.
- Activity announcements. Where drops, level-ups, quests, boss kills, Citadel visits, joins and leaves are announced.
- Welcome message. Design the message new members get: an embed or a container, with a preview and a Send test button.
- Goodbye message. A line posted when someone leaves, with clickable variables and a preview.
- Autoroles. Roles given to everyone who joins (and a separate list for bots), straight away or after a delay of up to 7 days.
- Role panels. A message of buttons members press to take or drop a role. Choose any number, or only one at a time, and see a live preview.
- Starboard. Messages that collect enough of a reaction (a star by default) are reposted in a channel you choose.
- Automatic replies. Reply to a word or phrase in your server's messages with text you write, with a cooldown so it can't spam.
- Giveaways. Start a giveaway with an Enter button and a timed draw. See who entered, end one early, draw again, or delete it.
- Suggestions. Members post ideas with /suggest and everyone votes. Reply here: approve, deny or mark them implemented.
- Auto-clean. Channels that delete their own old messages after an age you choose, keeping pinned messages. Check it on a test channel first.
- Moderation log. A channel where bans, unbans and timeouts are recorded, with who did it and why when RuneClan Bot can read the audit log.
- New accounts. Be told when a Discord account younger than a number of days joins, or keep them out until they are old enough. Off by default.
- Auto-delete. Keep a channel free of Discord invites, links or files: a matching message is deleted at once and the person is told why. Moderators are never affected.
- Event manager. Run bingos, scavenger hunts, XP competitions, boss nights or your own custom events: objectives, teams and players, proof to approve, standings, buy-ins, prizes and payouts. Start one with the standard options in a click, a few quick questions, or a guided setup of every option that keeps a draft as you go; save an event's setup as a template to make similar ones fast. For team events, a team builder lets you drag players onto teams with star ratings drawn from their linked RuneScape accounts, see how level the teams are, and call them final (or use /events team in Discord). Once signups are closed and the roster is confirmed, an event can have its own Discord roles and channels made for it: a role for the players and the organisers (and each team), and a category with private channels only the right people can see, kept in step as players join, leave or change team. Each event can post its own signup, and members see their own place and prizes on their profile.
- Points. Switch on a points ledger for your server, name the points, give or take them with a reason, and see the leaderboard and full history.
- Automod. Deletes invites, links, blocked words, shouting, spam and emoji floods automatically, and can give the writer a warning that counts toward Autopunish.
- Warnings. The record of warnings given with /warn. Search by member and take one back.
- Polls & signups. Where member polls are posted, and what members can start themselves.
- Tickets. Panels, the tickets themselves with their saved transcripts, settings, and panel defaults.
- Post a message and Scheduled posts. Write a message and have RuneClan Bot post it now or later, with headings, dividers, colours, images and buttons.
- Clan profile. How your clan appears to others: name, tagline, focus, recruiting status and where to apply. Unlisted by default (nothing shows until you pick an address); a public listing needs a clan Owner or Deputy Owner to verify the clan, and only clan-level facts are ever shown, never members.
- Public events. Choose which of your Discord events are shown in the public clan directory. Nothing is shared until your clan profile is public or unlisted.
- Alliances. Team up with other clans: invite a clan by its directory address, and share events with your allies only, without making them public.
- Clan plugin. How many of your members use the in-game clan plugin, as counts only. Nobody is named and nobody has to install anything.
- Roster. For a clan server: every member, who is verified, how fresh their data is, with staff-only notes.
- Checkup. Finds channels RuneClan Bot can't post in and roles it can't give out, and tells you how to fix each one.
- Activity log. Every change made from the dashboard, by whom and when.
Tip: press Ctrl + K anywhere in the dashboard to jump to a page by typing part of its name. Next to many settings is a small i: hover or tap it for a plain explanation of what the setting does.
Commands
| Command | Who | What it does |
|---|---|---|
| /rs | Everyone | Link your RuneScape 3 name, see your profile and stats, update your data, and manage your linked accounts. |
| /rsadmin | Admins and Support | Admin panel: review link requests, look up a player, refresh the clan, bulk actions. |
| /configure | Administrators | Quick server settings in Discord: clan name, admin roles and the review channel. The dashboard does all of this and more. |
| /poll | Linked clan members (changeable) | Create a poll, or end one you started. |
| /signup | Admins (changeable) | Create signups: queues, groups and submission forms, with a public panel for members. |
| /wrapped | Everyone (changeable) | A recap card for a week, month, year or all time: XP, Citadel, boss kills and more. |
| /ca | Everyone (changeable) | Look up a Combat Mastery achievement: its tier, scores and the wiki's tips. |
| /remindme | Everyone (changeable) | Set a personal reminder (10m, 2h30m, 1d), list yours, or cancel one. It arrives by DM. |
| /afk | Everyone (changeable) | Mark yourself away: people who mention you are told, and it clears the next time you speak. |
| /split | Everyone (changeable) | Split a drop between a group (1.5b, 250m, 12,500k), with an optional fee off the top and any left-over coins shown. |
| /suggest | Everyone (changeable) | Post an idea in the suggestions channel for everyone to vote on with the up and down buttons. |
| /warn | Admins (changeable) | Warn a member and keep a record: add, list and remove. The member is told by DM when their DMs are open. |
| /announce | Admins (changeable) | Post an announcement in a channel, optionally pinging one role, @everyone or @here. @everyone and @here only work for people who may mention everyone there. The dashboard's Announcements page does the same. |
| /events | Everyone (changeable) | Your events (place, points, buy-in, prizes), the ones open for signup, and join or leave. Events themselves are made and run from the dashboard. |
| /price | Everyone (changeable) | A RuneScape 3 item's Grand Exchange price with its 7 and 30 day change and a link to the wiki. Pick the item from the suggestions. |
| /worldevents | Everyone (changeable) | The Voice of Seren right now and the events that come round by themselves with how often, from the RuneScape Wiki. Hourly Voice of Seren reminders can be switched on from the RuneScape timers page. |
| /reset | Everyone (changeable) | Countdowns to the daily, weekly and monthly RuneScape resets. Reminders at each reset can be switched on from the RuneScape timers page. |
| /dnd | Everyone (changeable) | The Distractions and Diversions grouped by how often they can be played (daily, weekly, monthly, when available), read from the RuneScape Wiki. |
| /boss | Everyone (changeable) | A short RuneScape Wiki summary of a boss with its combat level, life points and weakness, and a link to its strategy page. |
| /quest | Everyone (changeable) | A short RuneScape Wiki summary of a quest with its difficulty and area, and a link to its quick guide. |
Each command on the dashboard's Commands page can be turned off, limited to certain groups or roles, and limited to certain channels. Admins can always use a command anywhere.
Linking RuneScape names
A member runs /rs and enters their RuneScape 3 name. Staff approve the request (or it is checked automatically where that is switched on), and from then on their profile, stats and recaps appear, and their roles follow the clan roster: Member while they are in the clan, Guest when they aren't.
- A name is owned by one Discord account. If someone else has it, the request is refused.
- A member who unlinks removes their name everywhere. An admin who removes a link does so for their own server only.
- Tracking needs a public Adventurer's Log. A private profile can be linked but not tracked.
Welcome messages
The welcome is designed on the dashboard's Welcome page, with a live preview and a Send test button that works while the welcome is switched off. A test needs a channel chosen first.
- Embed is the classic boxed message. A button can only sit underneath it, and the footer is always small and grey: Discord fixes both.
- Container is the newer layout. The footer is ordinary text, so it can be bright or bold, links work in every part, and the link button can sit inside the message. The editor switches to it for you when you ask for one of those.
- Variables fill in for each new member:
{user},{username},{avatar},{server},{count}and more, listed under the editor. In a container,{rs_button}places the link button on the line where you write it. - Links are written
[text](https://example.com). Pictures can be uploaded instead of pasted, and are shrunk to fit.
Tickets, polls and signups
- Tickets. Panels with your own questions, staff roles to ping and escalate to, and transcripts. For now they are set up with
/configurein Discord; the dashboard shows what is open. - Polls. Anyone allowed can make a poll with
/poll, and end the ones they started. - Signups.
/signupmakes queues, groups and submission forms, with a public panel members use and admin controls for you. The dashboard's Commands page can fix the admin channel and limit where public panels go.