Skip to content

Update debug documentation #8558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alessio-locatelli wants to merge 2 commits into
base: master
Choose a base branch
from
+37 −20
Open

Update debug documentation #8558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d7977d
docs: clarify how to run commands
alessio-locatelli May 7, 2026
938fea0
refactor(docs): auto-format via Prettier
alessio-locatelli May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 37 additions & 20 deletions docs/debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,50 @@

If you compile the game in debug, you have multiple debug features available.

## Debug commands
## Lua console

In-game you have the possibility to use the chat to trigger debug commands.
This is currently a replacement for a console.
Press **`` ` ``** (backtick) in-game to open the Lua console. All debug commands are run from there.
Tab-completion is available — type `dev.` and press Tab to browse available modules.

| Command | Description |
| ------- | ----------- |
| `help` | Shows a list of all debug commands with descriptions. |
| `god` | Toggles godmode. |
| ... | For the other commands see `help` ingame and there are a lot. |
### Common commands

Tip: Debug commands are also supported in quick messages. If you need a debug command frequently, put it in a quick message. :wink:
Comment thread
alessio-locatelli marked this conversation as resolved.

| Command | Description |
| ------------------------------- | ----------------------------------------------------------------------------------- |
| `dev.player.god()` | Toggle god mode (invincible, infinite mana). Pass `true`/`false` to set explicitly. |
| `dev.player.invisible()` | Toggle invisibility (monsters ignore you). |
| `dev.player.gold.give()` | Fill inventory with gold. Pass an amount to give a specific value. |
| `dev.player.gold.take()` | Remove all gold. Pass an amount to remove a specific value. |
| `dev.player.info()` | Print player position, HP, mode, and other state. |
| `dev.items.spawn("name")` | Spawn an item by partial name match. |
| `dev.items.spawnUnique("name")` | Spawn a unique item by partial name match. |

## Chat commands

The chat box is only available in **multiplayer** (Enter opens it). It accepts a few commands:

| Command | Description |
| ----------------- | ----------------------------------------------------------- |
| `/help` | Shows a list of all available chat commands. |
| `/seedinfo` | Show the seed info for the current level. |
| `/inspect <name>` | Inspect another player's stats and equipment (multiplayer). |

## Command-line parameters

| Command | Description |
| ------- | ----------- |
| `+` | Executes a debug command when loading the first game. For example `+god` or `+changelevel 1 +spawn 4 skeleton`. |
| `-f` | Display frames per second. |
| `-i` | Disable network timeout. |
| `-n` | Disable startup video. |
| Command | Description |
| ------- | --------------------------------------------------------------------------------------------------------------- |
| `+` | Executes a debug command when loading the first game. For example `+god` or `+changelevel 1 +spawn 4 skeleton`. |
| `-f` | Display frames per second. |
| `-i` | Disable network timeout. |
| `-n` | Disable startup video. |

## In-game hotkeys

| Hotkey | Description |
| ------ | ----------- |
| `Shift` | While holding, you can use the mouse to scroll screen. |
| `m` | Print debug monster info. |
| `M` | Switch current debug monster. |
| `x` | Toggles `DebugToggle` variable. `DebugToggle` is a generic solution for temporary toggles needed for debugging. |
| Hotkey | Description |
| ------- | --------------------------------------------------------------------------------------------------------------- |
| `Shift` | While holding, you can use the mouse to scroll screen. |
| `m` | Print debug monster info. |
| `M` | Switch current debug monster. |
| `` ` `` | Open the Lua console. |
| `x` | Toggles `DebugToggle` variable. `DebugToggle` is a generic solution for temporary toggles needed for debugging. |