First-Run Walkthrough
Short, in-place explanations that appear the first time something happens to a player, so nobody has to be told how the script works out of character.
🔁 How it works
There are four tracks. Each one fires once per character, at the moment it becomes relevant, and is then remembered on their profile so it never comes back.
Nothing plays at login. A player who never goes down never sees the death walkthrough.
| Track | Fires the first time they… |
|---|---|
death | Go down |
patient | Open a hospital check-in desk |
medic | Open the tablet while on duty as a medic |
care | Open a patient chart |
💀 Going down
The death screen explains itself the first time, under the heading "You are not dead yet":
- That they are bleeding out, not gone, and the countdown is how long a medic has to reach them
- What the distress signal does, every on-duty medic gets their location and can revive them where they fell
- What the AI medic costs, when nobody is on duty
- What respawning costs
The panel fades after deathHintSeconds (25 by default). Set it to 0 and it stays until they respawn.
🏥 The check-in desk
"What this desk does": that paying here hands them to the hospital's own staff, who patch them up automatically with no medic needed.
This is the one most players get wrong, because the desk looks like a shop.
🚑 The medic tour
Two parts.
On their first shift, going on duty shows a notification pointing at the tablet keybind: "Press F5 to open your medical tablet. It will show you around."
Opening the tablet then runs a guided tour of the sidebar. It rings each item in turn, dims everything else, and explains it in one sentence:
| Step | |
|---|---|
| Dispatch | Every distress signal a downed player sends. Respond to put their location on your GPS |
| Nearby patients | Opens the chart of a patient within a few metres, assess, treat and discharge |
| Medical records | Every encounter, scan, blood test and prescription, filed automatically |
| Callouts | Opt in and the city sends you NPC patients. They pay and count towards your level |
| EMS Academy | Training scenarios on a mannequin. Nothing is billed or recorded |
| Hospital | Who is on shift, which beds are free, and patients being brought in |
The tour skips any sidebar item that rank or config has hidden, so a trainee is never shown a page they cannot open.
🩺 The chart tour
The first time a medic opens a patient chart, the tour walks them through the panel itself, starting with "Look before you touch" in field view, and "Start with the vitals" in the full chart.
🔄 Replaying it
/tutorial wipes every track for the player who runs it and plays them all again from the next opportunity. Useful for testing your own wording, and for a player who clicked through too fast.
⚙️ Tuning
shared/config/tutorial.lua:
| Setting | Default | |
|---|---|---|
enabled | true | Turns the whole walkthrough off |
command | tutorial | false removes the command |
tracks.death | true | |
tracks.patient | true | |
tracks.medic | true | |
tracks.care | true | |
deathHintSeconds | 25 | 0 keeps the death panel up until respawn |
Every line of copy is a locale string, so it is translated and reworded in locales/, not in code.
Tracks are stored per character in the tutorials column of kaj_profiles. Clearing that column replays the walkthrough for that character.
For medics, the walkthrough only covers where things are. Learning what to actually do to a patient is what the EMS Academy is for.