Previous: Installation　·　Next: Core Concepts

⚡ Quick Start

Once QCL is installed, this page walks you through getting it running, understanding it, and making one change — in 5 steps. Each step comes with a command and the expected result; just follow along.

📌 Prerequisite: You have already installed QCL per Installation, and the server starts normally.

---

🎯 Beginner's 5-Step Checklist

Step	What you do	Command
1️⃣	Understand ecosystem status	/qcl status
2️⃣	View detailed diagnostics	/qcl status detail
3️⃣	Open the built-in example GUI	/qcl gui example
4️⃣	Change one config value and reload	Edit config.yml → /qcl reload
5️⃣	Test by referencing an item source	Use an item source reference string

---

1️⃣ Run /qcl status and read the output

The first thing to do is always a health check:

/qcl status

Permission: qcl.status　·　Alias: /qcl probe

It outputs an ecosystem status summary, typically including:

Output item	Meaning
Platform status	Normal / Abnormal
Health code	Overall health code (when abnormal, troubleshoot by code)
Module health	Overall status of the 22 core modules
Script bridge / loaded script count	Whether the script subsystem is ready
Economy bridge / PAPI / database / PDC health codes	Health codes for each subsystem
QI / QS / QF / QSt availability	Whether the gameplay plugins are detected
Config diagnostics / API boundary	Config and API status
Public API count / apiJar package count / internal package count	API boundary statistics
Startup diagnostics / item reference diagnostics	Startup-time and item source diagnostics

✅ Expected result: Platform status shows "Normal", and no health code is abnormal. If something is abnormal, note the health code and look it up in Diagnostic Codes.

---

2️⃣ Use /qcl status detail to see item-by-item detail

After reading the summary, if you want to dig deeper, use detail mode:

/qcl status detail

Permission: qcl.status　·　Alias: /qcl status full

On top of the summary, it additionally lists each module and each bridge line by line, and runs the script global:qcl_status.js:formatStatus to append custom diagnostic lines (script extension lines).

✅ Expected result: You can see the line-by-line status of all 22 modules, the line-by-line status of each bridge, and the script extension lines. This is the key tool for tracking down "exactly which module/bridge went down".

---

3️⃣ Open the built-in example GUI

At startup, QCL loads all GUIs in the guis/ directory. Try opening the example:

/qcl gui example

Permission: qcl.gui　·　Players only

✅ Expected result: An example GUI interface pops up. ❌ If you get "GUI not found: example", it means there is no GUI file with that id under guis/ — you can build one yourself by following Custom GUI.

---

4️⃣ Change one config value and run /qcl reload

Open plugins/QinhCoreLib/config.yml, change any value (for example, a module toggle in the modules: section), save it, then run:

/qcl reload

Permission: qcl.admin　·　Alias: /qcl rl

/qcl reload does all of the following in one go:

• Re-reads config.yml (reloadConfig)
• Re-initializes the economy bridge (EconomyBridge.init)
• Reloads the script bridge (QinhScriptBridge.reload)
• Reloads external item modules (Groovy)
• Reloads all GUIs

✅ Expected result: The config takes effect immediately, no server restart needed. ⚠️ Note: Enabling/disabling in the modules: section is a module-level toggle; some deeper changes still require a restart — when in doubt, restart.

---

5️⃣ Test by referencing an item source

QCL unifies items from 10 sources into a single set of reference strings. Any sub-plugin that goes through ItemSourceManager can use them. Common forms:

Form	Meaning
vanilla:DIAMOND or DIAMOND	Vanilla item
mm-龙剑	MythicMobs item
mi-SWORD-烈焰剑	MMOItems item
qi:神剑	QinhItems item
ia-包名_物品	ItemsAdder item
nx-枪	Nexo item

Try filling in a reference anywhere that supports item sources (such as a GUI icon, or an action that gives an item) — for example, start with the most reliable vanilla one:

# In some config option that supports item sources
item: "vanilla:DIAMOND"

✅ Expected result: The corresponding item is resolved correctly. 📖 For the full comparison table of all 10 sources, see Item Source Reference.

---

🧾 Command Cheat Sheet

Command	Permission	Purpose
/qcl	—	Show help
/qcl status (probe)	qcl.status	Ecosystem status summary
/qcl status detail (full)	qcl.status	Detailed status (per module / per bridge / script extension lines)
/qcl reload (rl)	qcl.admin	Reload config, economy, scripts, item modules, GUIs
/qcl gui <id>	qcl.gui	Open the specified GUI (players only)

The root command /qcl has alias /qinhcorelib. For the full command and permission list, see Commands and Permissions.

---

📚 Further Reading

• Next: Core Concepts — Understand modules, bridges, item sources, diagnostics, and the API boundary
• Configuration File — config.yml explained in detail
• Diagnostics and Troubleshooting — What to do when status is abnormal