Setup Guide
Out of the box the bot is a generic Adeptus Astartes chapter keeping records
in the Archive. This guide turns it into your chapter: your name, your
colours, your ranks, your honors, your wording.
Nothing here needs code. Every change applies instantly and only to your own
server.
Who can do this: anyone with the Manage Server permission.
Two ways to configure
In Discord. Type /config and press enter. A private panel appears that only
you can see. It has several pages, use the arrow buttons at the bottom to move
between them. On it you will find:
- Two role pickers at the top of page 1.
- A dropdown reading Edit a text setting... for names, mottos and flavour text.
- A second dropdown for the structured settings: colours, ranks, points, honors,
titles, vocabulary and the rest. Related settings sit behind a single entry
ending in …, which opens a second short list.
On the website. Sign in with Discord, pick your server from the list, and
everything is on one page with a jump list down the left. Larger jobs like the
rank ladder or the honor catalog are easier here, because you can see every entry
at once instead of editing a block of text.
Both edit the same settings. Changes save instantly either way.
Step 1. Set your roles
Do this first, most things depend on it.
How: open /config. On page 1 there are two dropdown pickers. Click the
first and choose your member role, then the second and choose your officer role.
On the website these are the Member role and Officer role boxes under
Roles and permissions, where you type the role name exactly as it appears in
Discord.
- Member role. Who counts as one of your people. Someone without it can still
be tagged in a report, but nothing is saved to their record.
- Officer role. Who can log for others, promote, award honors and run events.
Anyone with Manage Server counts as an officer whether or not they hold the role.
Step 2. Name your chapter
How: /config, then the Edit a text setting... dropdown. Pick a setting,
type the new value in the box that appears, and press submit. One at a time.
The ones to set now:
- Ledger name, what the bot calls its record book, for example
The Red Ledger - Chapter name, for example
Blood Ravens - Chapter motto, for example
Knowledge is Power. Guard it Well. - Chapter sigil, a custom emoji for report footers, for example
:bloodravens: - Header sigil, a plain emoji beside report titles, for example
🩸
Step 3. Choose your colours
The coloured stripe down the left of the bot's messages.
How, on the website: open the Colours section and click a swatch to pick
a colour, or type a hex code.
How, in Discord: /config, second dropdown, choose Colors. You get four
boxes and type a hex code in each, for example #7A1111.
- Primary, reports and dossiers
- Gold, honors and promotions
- Dark, sieges and notices
- Alert, warnings and resets
Step 4. Set your vocabulary
Rename the words the bot uses in its messages.
How, in Discord: /config, second dropdown, choose Vocabulary. A menu
lists every word. Pick one and you get two boxes, singular and plural.
How, on the website: the Vocabulary section shows every word with its
singular and plural side by side.
The words you can rename: brother, company, squad, operation, captain,
lieutenant, siege, gene-seed, armoury, honor, and rank.
For example, set brother to trooper and troopers, or squad to lance and
lances. This changes the bot's wording only, never the command names.
Step 5. Build your rank ladder
How, in Discord: /config, second dropdown, choose Ranks. You get one
big box holding the whole ladder, one rank per line, in this format:
0 = Aspirant
1 = Scout
36 = Battle-Brother
186 = Veteran
2000 = Company Ancient
How, on the website: the Rank ladder section gives each rank its own two
boxes, points and name. To add more, use the box at the bottom, one per line as
points, name. To delete a rank, clear its name.
Two rules: the lowest rank must start at 0, and no two ranks may share the same
number. When someone crosses a threshold the bot promotes them, and if a Discord
role exists with exactly that rank's name it applies the role too.
If a rank's name is too long for a nickname, give it a short form under **Short
rank names** on the website. Strike Team Leader can rename people to
[STL] Andrain while still applying the full Strike Team Leader role.
Step 6. Tune the points
How: /config, second dropdown, choose Points…, then the form you want.
On the website they are all together under Points.
What you can set:
- Points for each operation difficulty
- Points for a siege, and for each extra wave
- Base points per stratagem tier, plus per buff and per debuff
- Points for a win and for a loss in Eternal War
- Points per gene-seed and per armoury cache
Start with the defaults and adjust after a week of real logs.
Step 7. Reward running together
The squad bonus pays extra points to everyone on a report when more than one of
your people is credited on it. It is off until you turn it on, so nothing changes
until you set it.
How, in Discord: /config, second dropdown, Points…, then **Squad bonus
points**. Three boxes:
- Points per other brother. What each person earns for every other one
credited alongside them. 0 switches the bonus off.
- Maximum bonus. A ceiling.
0means no ceiling. - Applies to. Which reports it counts on, one per line, from
operations,
sieges, stratagems and eternalwar.
How, on the website: the Squad bonus section, with a box for each number
and a tickbox per report type.
Set the points to 2 and leave the maximum at 0 and a pair earns +2 each, a
trio +4 each, a full fireteam +6 each. Set the maximum to the same number as
the points and it becomes a flat bonus instead, paid once no matter how many
turned up, so bringing one person is rewarded but stacking a fireteam is not.
Only people holding your member or officer role count towards it. Guests can be
tagged on a report as before, but they do not raise anyone's bonus.
The bonus is included in the points shown on the report, so /undolast takes it
back off with everything else. Reports already logged keep the points they were
given.
Step 8. Set up honors
Honors are your medals, sorted into categories.
How, in Discord: /config, second dropdown, choose Honor categories to
name the categories, then choose an individual category to fill it with honors,
one per line.
How, on the website: the Honors section shows every category with its
honors in a box beneath it. Type one honor per line. Rename a category and its
honors move with it. Clear a category's name to delete it.
For example, a category called Marksmanship holding:
Marksman
Master Marksman
Sniper Adept
If a Discord role exists with the same name as an honor, awarding that honor also
grants the role. Officers award them with /awardhonor, or /bestow for a
formal proclamation in the channel. To give several at once, use /bestowmany,
which announces them all in one proclamation.
Step 9. Set your titles
The headings on the bot's messages: the profile, the leaderboard, promotion
notices, and the field names on reports such as Spoils of War.
How, in Discord: /config, second dropdown, choose Titles…, then a
group. Each group gives you a box for each heading in it.
How, on the website: the Titles section lists them all, grouped the same
way.
Clear any box to put that heading back to its default.
Step 10. Set your banners
The header line at the top of each report.
How: /config, Edit a text setting..., then choose one of the header
settings, for example Operation report header. There is also a **banner
format** setting that controls the decoration around it, for example:
=-=-= {sigil} {text} {sigil} =-=-=
Step 11. Set the nickname prefix
When someone is promoted the bot can rename them to show their rank.
How: /config, Edit a text setting..., choose **Promotion nickname
prefix**. Type a format using {rank} where the rank should appear:
[{rank}] {name}
That turns a promotion to Sergeant into:
[Sergeant] Cassius
Two limits: the bot cannot rename the server owner, that is a Discord
restriction, and the bot's own role must sit above the roles it manages.
Step 12. Set up companies and squads
How, in Discord: /config, second dropdown, choose Structure…, then
Company / squad structure. You set how many companies you have, how many
squads each holds, and how many people fit in a squad.
How, on the website: the Company structure section lists every company
with a dropdown each, so any single company can break the pattern:
- Use the defaults, follows the numbers above
- Custom squads, its own squad count and size
- No squads, one flat roster with a capacity
Companies can carry up to five extra command posts, and squads up to two, both
named under Command posts on the website. They only appear on a roster once
somebody is appointed with /company_setpost or /squad_setpost.
Specialist divisions are named formations outside the ten companies, each
with its own capacity, role and three tiers of leadership. Set them up on the
website; a brother is in a company or a division, never both.
Step 13. Set up the wargear ladder
A second ladder, separate from ranks. It lists what someone becomes authorized to
bear as they earn points, and appears on their profile and on page 2 of
/ranks.
How, in Discord: /config, second dropdown, choose Wargear ladder. The
first box names the ladder, for example Gear Authorization. The second holds
the entries, one per line:
0 = Bolt Pistol
250 = Power Sword
1000 = Relic Blade
How, on the website: the Wargear ladder section, with a box for the name
and a row for each entry.
It grants no roles and renames nothing. Leave it empty to switch it off.
Step 14. Add custom word swaps
Step 4 covers the common words. If you want to rename anything else the bot says,
add a swap here.
How, in Discord: /config, second dropdown, choose Custom word swaps,
then one per line:
mission = contract
fireteam = cell
How, on the website: the Custom word swaps section, with a row per swap.
Whole words only, so renaming mission will not touch missionary, and capitals
are matched automatically, so Mission becomes Contract.
Step 15. Everything else
Worth setting once the basics are in place. All of these are in /config, either
in the text dropdown or the second one.
- Timezone, so scheduled events start when you expect. Set it with
/settimezone, for example America/Chicago
- Inactive days, how long before someone appears in
/inactive - Digest channel, set with
/digest, for a periodic activity summary - Bot news channel, set with
/botnews, to receive update announcements - Tracked fields, under Tracked & report fields…, switch off gene-seed,
armoury, items, kills or objectives if your chapter does not use them
- Report verification, hold every report until an officer approves it, so
nothing needs undoing when one is wrong
- Service studs, long-service awards at intervals you choose
- Champion title, the name of your top honour and what the outgoing holder
falls back to
Step 16. Keep a copy of your records
Everything the bot stores for your server can be exported, so a mistake, an
outage or a lost server does not take your records with it. There are four ways
to do it and you can use any, all, or none of them.
Right now, no setup: run /export. The bot sends you spreadsheet files for
brothers, honors, rosters and log history, plus a JSON file. The same downloads
are on this website under Export on your server's settings page.
The CSVs are for reading: open them in Google Sheets with **File → Import →
Upload**, or in Excel. The JSON is the one that can put everything back, so
keep a copy somewhere that is not Discord and not this website.
A weekly copy, sent automatically
How: /config, second dropdown, choose Data export.
- Weekly archive channel ID. Where the archive is posted.
0switches it
off. Right-click a channel and Copy Channel ID.
- Also DM the server owner. Sends the same files to the owner's DMs. Worth
turning on: if the server itself is lost, a post in one of its channels goes
with it.
- Which day it runs. A day name,
sundayby default.
/exportnow sends it early without waiting for the day.
A Google Sheet that keeps itself up to date
The bot can write straight into a spreadsheet, one tab per table, refreshed every
day. Nobody has to remember to export anything.
This one needs a little setup, because Google has to be told the bot is allowed
to write to your sheet.
1. Create a Google Sheet. Name it whatever you like; the bot creates and
fills the tabs itself.
2. Copy its ID from the address bar. In
docs.google.com/spreadsheets/d/1A2b3C4d5E6f7G8h9I0j/edit the ID is the
bold part between /d/ and /edit.
3. Share the sheet with the bot's service account, as an Editor. That is
an email address ending in .gserviceaccount.com — ask whoever runs the bot for
it. Without this step Google will refuse, and the bot will tell you so.
4. Paste the ID into Google Sheet ID in /config → Data export, or
into the same box on this website.
5. Run /exportsheet. It fills the sheet immediately and tells you if
anything is wrong. After that it refreshes once a day on its own.
If it says it cannot reach Google Sheets, the bot's host has not been given
Google credentials. That is a one-time job for whoever hosts the bot, not
something a server can fix from /config. Everything else on this page works
regardless.
A note on what leaves the bot. The other three options keep your records
between you and Discord. A Google Sheet means your roster — Discord IDs, names,
points and honors — is also held in your Google account. That is your data in
your own sheet, but it is worth knowing before you switch it on.
A worked example
Turning the bot into the Storm Wardens, a fictional chapter, from a fresh
install:
1. /config, role pickers: member role Battle-Brother, officer role
Chapter Command.
2. /config, text dropdown: chapter name Storm Wardens, motto
By Storm and Steel, ledger name The Stormward Rolls.
3. Colours: primary #3E6B8A, gold #C9A24A.
4. Vocabulary: leave brother alone, but set squad to battle-line and
battle-lines.
5. Rank ladder:
0 = Neophyte
25 = Battle-Brother
200 = Sword Brother
750 = Veteran Sergeant
2000 = Master of the Watch
6. Squad bonus: 1 point per other brother, maximum 2, on operations and
sieges. Running as a pair is worth a little more than running alone, and a full
fireteam a little more again, without making solo play pointless.
7. Honors: a category Storm Honors holding:
Stormbound
Thunder's Edge
Keeper of the Gale
8. Wargear ladder named Armoury Access:
0 = Bolter and Combat Knife
300 = Power Weapon
900 = Terminator Plate
9. Create Discord roles named exactly Neophyte, Battle-Brother,
Sword Brother, Veteran Sergeant and Master of the Watch, then drag the
bot's own role above them so promotions can apply them.
What cannot be changed
- Command names.
/operation,/siegeand the rest are fixed by Discord
when the bot's commands are registered.
- Difficulty names, which follow the game.
- Game mechanics. Gene-seed and armoury data can be renamed in the
vocabulary, but how they score follows Space Marine 2.
Tips
- For promotions to apply roles, the bot's role must sit above the rank roles
in Server Settings, Roles.
- Settings are per-server. Resetting settings does not delete anyone's records.
- Run
/helpfor the member commands, or/helpofficerfor the rest. - Run
/ranksat any time to see your ladder as your members see it. - Run
/exportnow and then, or set up the weekly archive in Step 16.