Handbook
Everything Crawler HUD does, for players and dungeon masters alike.
Getting started
Open the log-in screen and choose “Need an account?”, or use “Continue with Google”. You can log in with a username — an email address is optional.
- ›Username — how you log in. Your username or email both work at the log-in screen.
- ›Display name (optional) — what other players see; you can change it later.
- ›Email (optional) — used for password reset links and account confirmations.
- ›Security question and answer — the fallback if you forget your password and gave no email.
Forgetting your password
“Forgot your password?” gives you two routes: answer your security question and set a new password on the spot, or — if the account has a real email — get a reset link. Answers are stored hashed and salted and are only ever checked on the server.
Account Settings
Open Account Settings at the bottom of the HUD. It holds everything about your account in one place.
- ›Profile — your username and an editable display name.
- ›Email — username-only accounts can link a real email; others can change theirs. A confirmation link is sent first, and your username keeps working.
- ›Password — change it by typing the new one twice. Google-only accounts see “Add a password”, which is optional.
- ›Account recovery — set or change your security question and answer.
- ›Supporter status — link Patreon, and press “Check membership” to refresh your perks.
- ›Danger zone — “Delete account…” removes your account and all your crawlers forever. You must type DELETE to confirm.
- ›Sign out — at the bottom, next to the account you're signed in as.
The log-in page also links to the Crawler HUD Discord and Patreon.
Getting help
Need support, found a bug, or have an idea? Join the Crawler HUD Discord: https://discord.gg/v397Hkfsz — the same link sits in Account Settings under “Help & support”.
Top bar and windows
Every signed-in page has a slim top bar. It fades out while you work and lights up when you point at it.
- ›← Back — returns to the page you were on, or the HUD if there isn't one.
- ›Audio on / off — mutes or unmutes every chime, alarm and fanfare. Remembered on your device.
- ›Compact on / off (crawler sheets) — off lets text boxes grow to fit everything; on keeps them short and scrollable.
Pop-out windows
- ›⧉ — floats a box over the page. Drag it by its title, resize from the corner. It stays open while you switch tabs and remembers its spot.
- ›⇱ — opens the box in its own browser window, so you can drag it onto another screen. Changes there save and update live. It closes if you leave or reload the page it came from.
- ›⤓ — docks the box back into place. You can also click the dashed placeholder it left behind.
Chat dock
A chat button sits at the bottom left of every signed-in page. It opens a draggable, resizable chat window grouped by campaign, with unread counts that glow.
The HUD
Your home screen after logging in.
- ›Your crawlers — create as many as you like by name; each is a full sheet that belongs to you. A crawler can sit in one party at a time.
- ›Join a party — enter the party code your dungeon master gives you, then pick which crawler is playing. Older parties have 6-character codes, newer ones 10; both work.
- ›Campaigns you run — create a campaign to become its dungeon master. It tracks a floor, a day and an hour that the whole party sees.
- ›The Void — your private vault of ready-made content for every campaign you run.
- ›Account Settings — see Getting started.
Leaving a party or deleting one you run always asks for confirmation first.
The crawler sheet
Everything saves automatically a moment after you stop typing, and changes your dungeon master makes appear live. Only you and your campaign's dungeon master can edit. On desktop the tabs stay in one row.
Portrait
- ›Click the portrait at the top of Core Identity for Upload image, Image link or Remove.
- ›Uploads open a crop window: drag to place, scroll or slide to zoom, then “Use photo”. Pictures are shrunk on your device to a tiny square.
- ›Image links are used as they are. With no picture, the frame shows your initials.
Main
- ›Identity — name, crawler number, size, level, race, class and floor, beside the portrait.
- ›Defense — Evade and DR totals and buffs, plus Move and Stop. Move and Stop work in roll formulas as MOVE and STOP.
- ›Health — ten bars, each holding hit points equal to your Constitution modifier (minimum 1). Click a bar to empty or refill it.
- ›Stats — the five stats with enhanced and unenhanced values; the modifier comes off the enhanced one. A stat boosted by gear shows its total in amber — hold the mouse over it to see what's boosting it.
- ›Evade (Dexterity modifier plus buffs), damage resistance, mana, and an AI favor counter with + and − buttons.
- ›Buffs & Debuffs — buffs on the left, debuffs on the right.
- ›Attacks — name, to-hit, damage, effects.
- ›Party status — your teammates' health and mana, plus NPCs the dungeon master has made visible, when the dungeon master switches it on. Tap a teammate to view their sheet.
Hotbar
- ›Ten slots. An empty slot shows a dashed ◇ — click it (or the small ▾) to pick a skill, spell, attack or item.
- ›Point at, tap or click a filled slot to see that entry's details card. Close name matches still find the item, and anything without a match shows as “Custom”.
- ›× clears a slot.
Gear and accessories
- ›Six gear slots (head, torso, arms, hands, legs, feet), tattoo/patch slots and up to thirty accessory lines.
- ›Click ◇ to pick an item from your inventory, or choose “✎ Type a name…”. With an empty inventory, a text box opens straight away.
- ›Filled slots show a details card on hover or tap, and × clears them.
Inventory and attachments
- ›Items with quantity, rarity, type and notes, plus your loot boxes and gold.
- ›Press + on an item to add an attachment — a gem, rune or mod — with a name, notes and an optional stat change such as +2 STR.
- ›An item's stat changes count while it's in a gear slot or ticked ✓ equipped. Doing both counts it once — bonuses never stack.
- ›The details card shows Equipped: Yes (slotted), Yes (inventory), Yes (both) or No, and lists every attachment.
- ›Loot boxes your dungeon master sends appear here to open. Your dungeon master or a co-DM can also open them for you.
Other tabs
- ›Character — sponsors, deity, clubs and guilds, notable kills, popularity, past trauma, loose ends, regrets and notes.
- ›Skills — name, rank, stat, check type, notes, AI favor, grind, done.
- ›Spells — name, rank, check type, stat, mana, range, duration, cooldown, notes, done.
- ›Pets — a card each with a portrait, health bars and MP like an NPC, the five stats with their modifiers, optional check and damage rolls that use the pet's own stats, attacks, specials and equipment, and an Items list — give items from the crawler's inventory (⇠ takes them back), pull one from the Void or type one in. ◈ copies a pet, items included, to the Void; “Pet from Void” adds one.
- ›Journal — your own tabbed pages; add, rename and delete them. Only you and your dungeon master see it.
- ›Announcements, Chat and Contacts — see their sections below.
Level-ups
“+ Level” numbers the new row from the last one, bumps your level and hands you three banked stat points. Banked equals three per level gained, plus your manual adjustment, minus everything already assigned.
| Enhanced stat | Modifier |
|---|---|
| 1–2 | +1 |
| 3–5 | +2 |
| 6–9 | +3 |
| 10–19 | +4 |
| 20–49 | +5 |
| 50–99 | +6 |
| 100–149 | +7 |
| 150–199 | +8 |
| 200–299 | +9 |
| 300+ | +10 |
Export and import
Export downloads a dark-themed spreadsheet of the whole sheet. Import reads one back in; blank cells keep whatever the sheet already had. You can also delete a crawler from here.
Announcements
Your inbox from the dungeon master — party-wide and personal messages, newest first, arriving live.
- ›Notice — lands quietly with a soft chime and a glowing tab.
- ›System announcement — takes over the screen with an alert you must acknowledge.
- ›Achievement — a pop-up with the achievement's name and description, and a fanfare.
- ›Once you acknowledge an announcement it never pops up again.
Chat
Chat works once your dungeon master switches it on for the party. It lives in the chat dock and in your sheet's Chat tab.
- ›Channels run down the side with unread counts: Party, whispers, and groups you name and fill — NPCs included.
- ›You speak as your crawler; a dungeon master can also speak as any NPC.
- ›You can delete your own messages; the dungeon master can delete anything.
Slash commands
| Command | Does |
|---|---|
| /w <crawler> <message> | Whisper one crawler directly |
| /p <message> | Send to the party channel |
| /g <group> <message> | Send to a named group |
| /roll 1d20+3 | Roll dice into the channel |
| /me <action> | Emote, shown in italics |
Type “/” and a suggestion list appears — arrows to pick, Tab or Enter to fill in.
Outside chat invites
- ›When the dungeon master switches on Outside Chat Invites, each crawler gets a long ID like 12345-6789, shown on the Chat and Contacts tabs.
- ›Anyone with an account can type that long ID under “Join outside chat by ID” on one of their crawlers' Chat tab.
- ›Guests get party chat, whispers and groups, and become a contact of that crawler. They can't see sheets, quests or anything else.
- ›Guest chats show as their own buttons next to “My party”; × leaves. Switching the feature off removes all guests.
Contacts
Every crawler in a campaign gets a five-digit ID, shown at the top of the Contacts tab with a copy button. NPCs have one too. Contacts work once the dungeon master switches them on.
- ›Add by ID — type someone's five-digit ID to send a request. Short IDs only work inside your own campaign.
- ›Requests waiting on you — accept or decline; accepting links you both ways.
- ›Known contacts — each with a Whisper button.
- ›NPCs can be added the same way; the dungeon master accepts for them.
Running a campaign
The dungeon master screen. Every section collapses with a click on its title, and boxes fit together in two columns.
- ›Header — campaign name (owner can Rename), the party code, and the floor / day / hour clock, pushed live to every player.
- ›Party Roster — members, with the owner able to make someone a co-DM.
- ›Party Features — switches for Chat, Contacts, Loot Boxes, Party Status and Outside Chat Invites. Turning one on needs a supporter membership on the dungeon master's account; players never need one.
- ›Party Status — a card per crawler with health bars to toggle, mana to set and an AI favor counter. Tap a card to open that sheet.
- ›NPCs — searchable compact list; open one to edit its name, description, portrait, stats, skills, attacks and gear. “Show to party” and “show stats” control what players see. ◈ To Void saves a copy.
- ›Mob Directory — a private bestiary with HP, damage reduction, health bars, attacks, abilities, loot and portraits, searchable, with ◈ To Void.
- ›Quest Log — title, details, reward, status and an optional assigned crawler, with filters and search.
- ›System Announcements — notices, full-screen announcements or achievements, from you or an NPC, to the party or one crawler. Previous Announcements and Achievements keep a searchable log.
- ›Attach loot — add an item from your library (with an amount) or a sealed loot box to any announcement or achievement; it's delivered alongside the message. Achievements on the Loot Bench have the same options, a “Sends as:” preview and save-to-Void.
Loot Bench
- ›Build an item, skill, spell or loot box, save it to the party library, and send it to the party or one crawler — silently, as a notice, or as an announcement.
- ›Loot boxes hold picked items (with an amount, like 5 potions) or random loot of a chosen rarity, and can be sent several at a time. Sending boxes needs Loot Boxes switched on.
- ›◈ Void loads a saved entry; Ready stages it for later. The library has an All / Items / Skills / Spells filter.
Roll tables
- ›Step 1 — add entries from your library or the Void as tags, filtered by type, source, rarity and search, or press “Add all shown”.
- ›Step 2 — set each row's weight, type and result; its chance updates as a percentage.
- ›Saved tables sit on the right with search. Roll once or up to 20 times; the newest result is highlighted.
- ›When an item, skill or spell comes up, “Give to…” sends it to the party or one crawler.
Readied actions
- ›Press Ready on an announcement, quest or Loot Bench entry, or use ◈ Void, to stage it.
- ›The Readied Actions box filters by type and search; Fire sends one, × drops it, and ◈ Void saves it to your Void.
- ›Readied actions are saved on the device and browser you made them in.
Co-GMs
- ›The owner can make any party member a co-DM from the Party Roster.
- ›Co-GMs can send items, skills, spells and loot boxes, open crawlers' sealed loot boxes, send announcements, edit sheets and use the GM options in chat.
- ›Only the owner can rename or delete the campaign.
The Void
A private vault of ready-made content that works in every campaign you run. Open it from the HUD. The buttons across the top switch between its parts.
- ›All departments — every saved entry grouped by type, with one search box, a type filter and Edit buttons. Each entry is tagged Original, Meat Grinder (with the maker's name) or Point Mongo, and the Source row filters by it.
- ›Plain names — the “Plain names (Items, Skills…)” tick box under the All departments banner swaps the themed department names for plain ones. Remembered on your device.
- ›Requisitions Workshop — every creation form in one place: Items, Skills, Spells, Classes, Announcements, NPCs, Mobs and Loot Boxes. Stored entries are on the left with their own search; the form is on the right (first on a phone).
- ›Pets — save companions and mounts, share them in the Meat Grinder, and pull them onto any crawler sheet.
- ›Bulk ship to campaign — tick several items, skills or spells and add them all to one campaign's Loot Bench library at once.
On the dungeon master screen, ◈ Void buttons on the Loot Bench, announcements, achievements, NPCs, Mob Directory and Readied Actions pull entries in with all their settings, or save them back.
The Open-Source Meat Grinder
- ›A shared library of everyone's creations. Feed an entry from your Void with its ⚙ button to post it.
- ›Tap any entry to see everything in it — full portrait, every field and, for mobs and NPCs, the stat block laid out like the DM screen. Clone copies it into your Void with credit to the maker.
- ›★ gives an entry a commendation; sort by Most commended. Spotlighted picks chosen by admins sit in a row at the top.
- ›Tap a maker's name to see their profile and creations. “My maker profile →” opens yours.
- ›Edit changes your own listings. Report flags an entry; three reports send it for review.
- ›Copies of existing listings, re-posted clones and anything flagged for slurs or obscenities wait in the Quarantine Airlock until an admin approves them. The poster sees why it was held.
- ›When a listing is taken down, clones of it are removed from everyone's Void too.
Point Mongo Supply Co. (beta testers)
- ›Browse the Point Mongo codex inside the Void. Preview shows an entry the way it will look in your Void before you Import it.
- ›Creatures bring their five stats, floor, size, move, type, boss tier, health bars, attacks and loot. Spells and skills bring damage, range, cooldown and rank upgrades; gear brings slot, tier and stat bonuses like +2 Strength; races bring bonuses, benefits and drawbacks.
- ›Anything without a matching box goes into the entry's notes.
- ›Point Mongo entries can't be posted to the Meat Grinder, and entries removed from Point Mongo disappear from your Void.
Sounds and alerts
- ›Arriving chat and notices play a soft chime.
- ›System announcements play an alarm; achievements play a fanfare.
- ›The Audio switch in the top bar mutes all of them, remembered on your device.
- ›Tabs with unread content glow with a count.
Foundry VTT bridge
The Crawler HUD Bridge module opens your crawler sheet inside Foundry, posts every roll to Foundry chat and keeps the token's health and stats in sync.
Install (DM, once)
- ›In Foundry's setup screen open Add-on Modules → Install Module.
- ›Paste https://crawlerhub.dev/foundry/module.json into Manifest URL and press Install.
- ›In your world, open Manage Modules and tick Crawler HUD Bridge.
- ›Prefer a file? Download https://crawlerhub.dev/foundry/crawler-hud-bridge.zip and unzip it into Foundry's modules folder.
Link a crawler
- ›Open the actor in Foundry and press Link in its title bar.
- ›Paste the address of the crawler's Crawler HUD sheet.
- ›Press Crawler HUD in the title bar to open the sheet in Foundry. Log in once inside the window the first time.
What syncs
- ›Rolls — any roll on the sheet appears in Foundry chat as that actor, with CRIT and FUMBLE marked.
- ›Health and stats — health and STR/INT/CON/DEX/CHA update on the actor, so token bars follow. The DM can turn this off in the module settings.
- ›Second screen — rolls made on a phone, tablet or other screen reach Foundry chat once the DM turns on the relay (below).
Roll relay for phones and tablets
- ›On the DM screen, open the Foundry Dashboard and press Turn on relay. Copy the key — it is shown only once.
- ›In Foundry, open Configure Settings → Crawler HUD Bridge and paste it into Relay key.
- ›Rolls from any sheet in the campaign now appear in Foundry chat within a few seconds, as the linked actor when there is one.
- ›Lost or leaked the key? Press Make new key — the old one stops working at once. Turn off removes it completely.
- ›The DM's Foundry must be open for rolls to show; rolls older than about ten minutes are skipped.
DM setup: spawning creatures in your Foundry
- ›Install Crawler HUD Bridge (manifest https://crawlerhub.dev/foundry/module.json) and enable it in your world under Manage Modules.
- ›Sign into that world as the GM and keep Foundry open — only the active GM's Foundry creates creatures.
- ›On the Crawler HUD DM screen, open the Foundry Dashboard, tick Use Foundry tools, press Turn on relay and copy the key (shown once).
- ›In Foundry: Configure Settings → Crawler HUD Bridge → paste it into Relay key and save. (Skip this if you run the DM screen inside Foundry itself.)
- ›Open the scene you want and centre your view where the creatures should appear.
- ›In the dashboard's Quick deploy list: Map drops tokens at the centre of your view (packs use the mob's Count, up to 20, numbered Goblin 1, Goblin 2…); Actor only adds them to a Crawler HUD folder in the Actors sidebar; Loot posts the mob's loot as a chat card.
- ›Mobs arrive hostile, NPCs friendly, with health, level and notes filled in.
If creatures don't appear
- ›'Relay key was rejected' in Foundry → press Make new key and paste the new one.
- ›Nothing happens → check Foundry is open as the GM, the module is enabled, a scene is active and Use Foundry tools is ticked.
- ›Only an actor appears, no token → no scene was active; open one and press Map again.
- ›Very large uploaded portraits are left off tokens; mob health changed in Foundry doesn't come back to Crawler HUD.
- ›Damage or healing on a linked crawler's token updates their health bars while their Crawler HUD window is open in Foundry.
Table tools
- ›Party rest (Party Status) refills every crawler's health bars and MP.
- ›Table Tools sets the DM's name in chat and announcements, and plays sound cues for the whole party.
