Skip to content

Previous: Configuration Fileใ€€ยทใ€€Next: Item Source References

๐Ÿ•น๏ธ Commands & Permissions โ€‹

QCL is built on the Cloud command framework. The command root is /qcl, with alias /qinhcorelib. This page provides the complete command tree, usage examples, expected output, the permission node table, and recommended permission group assignments.


๐ŸŒณ Command Tree Overview โ€‹

CommandAliasPermissionFunction
/qclโ€”NoneShow help
/qcl status/qcl probeqcl.statusEcosystem status summary
/qcl status detail/qcl status fullqcl.statusDetailed status (per-module / per-bridge / script extension lines)
/qcl reload/qcl rlqcl.adminReload config + economy + scripts + external item modules + GUI
/qcl gui <id>โ€”qcl.guiOpen a custom GUI (player only)
/qcl attr/qcl attributeqcl.adminAttribute system debug overview
/qcl attr listโ€”qcl.adminList all registered attributes (grouped by category)
/qcl attr show [player]โ€”qcl.adminView a player's attribute totals (summed across sources)
/qcl attr debugโ€”qcl.adminToggle hit-damage tracing (player only)
/qcl attr bookโ€”NoneOpen the attribute panel book (player only)
/qcl mobattr <key> <value>โ€”qcl.adminSet an attribute on the mob you're looking at (for testing, player only)

/qinhcorelib is the full alias of /qcl; all commands below can be used with the /qinhcorelib prefix instead.


๐Ÿ“œ /qcl โ€” Help โ€‹

Typing /qcl directly shows the help. No permission required. The help output has a fixed format: separator line + "Qinhuai Core Library" + three lines describing status / reload / gui.

โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”
Qinhuai Core Library
/qcl status  - View ecosystem & bridge status
/qcl reload  - Reload configuration files
/qcl gui <id> - Open custom GUI
/qcl attr  - Attribute system debug (list/show)
โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”

๐Ÿ” /qcl status โ€” Status Summary โ€‹

Permission: qcl.statusใ€€Alias: /qcl probe

/qcl status

Outputs a health summary of the entire Qinhuai ecosystem: soft-dependency probes (item source count + list, economy, attribute plugins, integrated plugins), platform status and health code, per-module health codes, health codes for each bridge (script / economy / PAPI / database / PDC), sub-plugin status (QI / QS / QF / QSt), config diagnostic code, API boundary code, item reference diagnostic code, and more.

Detailed Version โ€‹

/qcl status detail

Alias: /qcl status full. On top of the summary, it additionally outputs: bridge count, module count, TraceId, per-module (enabled/disabled + available/unavailable + message), per-bridge (enabled/disabled + available/unavailable + source + message), as well as the lines appended by the script global:qcl_status.js:formatStatus.

๐Ÿฉบ For the meaning, normal values, and exception handling of each item, see Diagnostics & Troubleshooting.


๐Ÿ”„ /qcl reload โ€” Reload โ€‹

Permission: qcl.adminใ€€Alias: /qcl rl

/qcl reload

During execution it shows "Reloadingโ€ฆ", and on completion shows "Reload complete".

๐Ÿ“ฆ What reload reloads โ€‹

Reload ItemDescription
configRe-reads config.yml
EconomyRe-initializes the economy provider
ScriptsReloads JS scripts
External item modulesRe-probes / re-integrates external item plugins
GUIReloads custom GUI definitions

โš ๏ธ Which changes reload can't handle and require a restart โ€‹

ChangeIs reload enough?
database.type or MySQL connection parametersโŒ Restart required (the connection is established at startup)
modules module switchesโŒ Restart recommended (affects module loading)
debug / economy / script content / GUI / item referencesโœ… reload is sufficient

See the "Change Effect Method Quick Reference" in Configuration File.


๐Ÿ–ผ๏ธ /qcl gui <id> โ€” Open GUI โ€‹

Permission: qcl.guiใ€€Player only

/qcl gui ไธป่œๅ•

Opens the custom GUI with id ไธป่œๅ• (Main Menu). If that id does not exist, it shows:

GUI not found: ไธป่œๅ•

๐Ÿ”— For GUI definition and development, see GUI Programming API.


๐Ÿ—ก๏ธ /qcl attr โ€” Attribute System Debug โ€‹

Permission: qcl.admin (the book subcommand needs no permission)ใ€€Alias: /qcl attribute

SubcommandFunction
/qcl attrOverview: configured backend / active backend / GraalJS status / registered attribute count
/qcl attr listList all attributes, grouped by category, tagged vanilla / item / storage type and damage type
/qcl attr show [player]View a player's attribute totals (omit to view your own; console must specify a player name)
/qcl attr debugToggle "hit damage tracing" โ€” prints the attribute resolution each time you deal / take damage (player only)
/qcl attr bookOpen the attribute panel book (player only, no permission)

๐Ÿ—ก๏ธ For how to configure attributes and write custom ones (yml + JS), see Attribute System.


๐Ÿฒ /qcl mobattr โ€” Set Attributes on a Mob (for testing) โ€‹

Permission: qcl.adminใ€€Player only

/qcl mobattr <attr key> <value>   # look at a mob (within 12 blocks) and set that attribute on it
/qcl mobattr clear                # clear all attributes from that mob

The fastest way to test a custom attribute: e.g. /qcl mobattr defense 100 gives the mob 100 defense, then hit it to see whether mitigation works.


๐Ÿ” Permission Node Table โ€‹

Permission NodeCommand(s) ControlledNature
qcl.status/qcl status, /qcl status detailView type (read-only)
qcl.admin/qcl reload, /qcl attr (incl. list / show / debug), /qcl mobattrAdmin type (side effects / debug)
qcl.gui/qcl gui <id>Player feature type

/qcl (help) and /qcl attr book require no permission and are available to everyone.


๐Ÿ›ก๏ธ Admin Group (admin / op) โ€‹

yaml
permissions:
  - qcl.status   # View ecosystem status
  - qcl.admin    # Reload configuration
  - qcl.gui      # Open GUI

๐Ÿง‘ Regular Player Group (default) โ€‹

yaml
permissions:
  - qcl.gui      # Only allow opening GUIs (as needed)

๐Ÿ’ก qcl.admin (reload) has side effects, so only grant it to trusted admins. qcl.status is usually only granted to admins/ops as well; regular players typically only need qcl.gui (or even not that, triggered by your own GUI sub-plugin instead).


๐Ÿ“– Further Reading โ€‹