Command Reference
In: Reference · Related: Permission Nodes · Troubleshooting · Back: Home
Root command: /qr, alias /qruins. The table below is the complete command tree, verified line by line against the source QinhRuinsCommands.kt.
Commands fall into two groups: player commands (permission qinhruins.use, granted to everyone by default) and admin commands (permission qinhruins.admin, OP-only by default, and automatically including use). Permission group setup is in Permission Nodes.
Convention:
<required>,[optional]. Most commands must be run in-game by a player (they involve location / inventory); pure query commands also work from the console.
Player commands (qinhruins.use)
| Command | Permission | Effect |
|---|---|---|
/qr | — | Open the help menu (no permission required) |
/qr help | — | Same as above, the help menu |
/qr version | qinhruins.use | Show the QR version number |
/qr list | qinhruins.use | List all templates (with generation mode) and all current anchors (coordinates + status) |
/qr near [radius] | qinhruins.use | List nearby ruin anchors (by distance); radius in blocks, default 200 |
/qr activate | qinhruins.use | Activate the ruin under / near you as a realm (search radius realm.activate-radius, default 48). Requires holding a keystone or meeting the activation condition |
/qr codex | qinhruins.use | Open the codex GUI (a collection album of strategy cards for discovered ruins) |
/qr reroll | qinhruins.use | Spend currency to reroll the affixes on the keystone in hand (requires realm.reroll.enabled: true) |
/qr reward | qinhruins.use | Open the cleanse reward slot machine of the most recent realm (claim personal exclusive loot) |
Party (qinhruins.use)
| Command | Effect |
|---|---|
/qr party create | Create a built-in party (you become the leader) |
/qr party invite <player> | Invite an online player to join the party |
/qr party accept | Accept the most recent party invitation |
/qr party leave | Leave the current party |
/qr party info | View the party member list |
For party gameplay (shared progress / rally radius), see Party & Session. If QinhClass / MMOCore is installed, parties can be taken over by them.
Guide (player side)
| Command | Permission | Effect |
|---|---|---|
/qr guide cancel | qinhruins.use | Cancel the ongoing guidance and return the guide item. You can bind any key (e.g. K) on the client to this command |
Guide items are granted by an item source (
qinhruins:guide_<templateId>); QR ships no give command. See Guide & Codex.
Admin commands (qinhruins.admin)
Reload
| Command | Effect |
|---|---|
/qr reload | Reload config.yml, languages, placement profiles, templates, blueprints, palettes, loot tables, affixes, tier / keystone / reroll config, and rebuild the anchor / chest / core / mechanism registries and all scheduled tasks |
Selection and saving (turn a build into a ruin)
| Command | Parameters | Effect |
|---|---|---|
/qr pos1 | — | Set the block your crosshair is aimed at (within 100 blocks) as the first corner of the selection |
/qr pos2 | — | Set the second corner of the selection |
/qr save <id> | id=new template id | Save the pos1~pos2 selection as template templates/<id>/ (with structure file and blueprint skeleton) |
/qr import <file> <id> | file=a .schem file name under schematics/; id=new template id | Import a WorldEdit .schem and convert it to a .nbt template |
See Selection & Saving · Structure Files.
Generation and placement
| Command | Parameters | Effect |
|---|---|---|
/qr spawn <template> | template=template id | Immediately place a ruin of that template under your feet (creates one anchor) |
/qr gentest | — | Trigger one director debug generation around you (about 25 blocks) and report a generation summary |
/qr why <template> | template=template id | Diagnose "why this template does / does not generate here": list, item by item, the pass status of placement conditions such as dimension / biome / flatness / spacing |
/qr scatter <radius> <count> | radius 100~20000; count 1~200 | Pre-generate (scatter) up to count ruins within the radius, for initial map seeding |
See Natural Generation & Preloading.
Preview staging (stage)
Before placing, preview the structure body in place with ghost blocks (visible only to you, no world changes). See Selection & Saving.
| Command | Parameters | Effect |
|---|---|---|
/qr stage start <template> | template=template id | Start previewing the template under your feet |
/qr stage here | — | Move the preview to your current position |
/qr stage move <dx> <dy> <dz> | three integer offsets | Nudge the preview position by an offset |
/qr stage rotate | — | Rotate the preview by 90° |
/qr stage confirm | — | Confirm placement (commit as a real structure) |
/qr stage cancel | — | Cancel the preview |
Each
stagesubcommand inherits theqinhruins.adminpermission from itsstageparent node in the source.
Anchor management
| Command | Parameters | Effect |
|---|---|---|
/qr tp <anchor> | anchor=anchor id | Teleport to the specified anchor |
/qr remove <anchor> | anchor=anchor id | Recycle the anchor (restore terrain if a snapshot exists, freeing a density slot) |
/qr markers <anchor> | anchor=anchor id | Scan the marker blocks inside that anchor's structure (spawn points / chests / cores / commands), write them back to the blueprint, and recapture the structure |
/qr info [anchor] | omitted=global status; with anchor shows a single ruin's details | No argument: an overview of template / anchor / session / tracker counts. With anchor: template, coordinates, status, session busy/idle, blueprint spawn points / chests / stage count, objective progress |
For marker blocks, see Structure Files.
Guide (admin side)
| Command | Parameters | Effect |
|---|---|---|
/qr guide clear <player> | player=player name | Force-clear a player's guidance state (no item refund) |
Realm / affixes / procedural
| Command | Parameters | Effect |
|---|---|---|
/qr keystone give <tier> [player] | tier 1~realm.tiers.max; player omitted=yourself | Grant a keystone of the specified tier |
/qr genstruct <palette> [dry|seed] | palette=palette id; dry=plan only, no placement; or an integer used as the random seed | Procedurally assemble a large ruin from a palette (dry only prints the assembly plan) |
See Realms & Keystones · Affix System · Procedural Generation.
Visual editor (editor)
Stand in the world to box-select, mark points, configure mechanisms, and save a template in one shot, never touching YAML. See Visual Editor.
| Command | Parameters | Effect |
|---|---|---|
/qr editor start <template> | template=template id | Enter an editing session, bound to that template |
/qr editor mode <spawn|chest|core> | one of the three modes | Switch the marking mode: spawn point / chest / core |
/qr editor set <field> <value> | field=mob/count/stage/loot/unlock; value | Set a field on the current marked point |
/qr editor mech <args> | mechanism parameters (greedy string) | Edit a mechanism; for parameters see Mechanism Editing |
/qr editor list | — | List the points marked in the current session |
/qr editor remove <id> | id=marked-point id | Remove a marked point |
/qr editor save | — | Save the editing session to the template |
/qr editor cancel | — | Cancel the editing session |
Each
editorsubcommand inherits theqinhruins.adminpermission from itseditorparent node.
Diagnostics / performance
| Command | Parameters | Effect |
|---|---|---|
/qr profile [reset] | omitted=view; reset=clear | View / reset the performance profiler (call count, average / max / total time per stage) |
For troubleshooting usage, see Troubleshooting.
Content packs (download / install)
Bundle ruin templates / generators / palettes / loot / blueprints / affixes into a single .zip, then download and install it in one command — no more hand-dragging files.
| Command | Parameters | Effect |
|---|---|---|
/qr catalog | — | List the content-pack catalog (the YAML at config.yml → content.catalog-url, default points to the official catalog) |
/qr download <packId> | packId=an id from the catalog | Download and install that content pack in one command |
/qr packs | — | List the content packs installed on this server |
When a content-pack
.zipis extracted, its top-level folders map to QR data folders by whitelist:templates/ generators/ palettes/ loottables/ blueprints/ sections/ lang/ affixes.yml; an optionalpack.ymlat the zip root declaresid / name / version. Run/qr reloadafter installing.
What the help menu includes
The entries printed by /qr help (from cmd.help-* in the language file commands.yml) cover: help / list / near / activate / reroll / reward / party (player section), and pos / save / import / spawn / why / stage / genstruct / editor / markers / guide / tp / remove / info / profile / catalog / download / packs / reload (admin section).