> For the complete documentation index, see [llms.txt](https://docs.nxcframework.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nxcframework.net/nexus-core-docs/running-your-server/commands.md). # Console commands Every console and in-game command. ## Console only These print to the server console. **Typed in game they do nothing**, which looks identical to a command that does not exist. | Command | What it tells you | | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `nxc_health` | Whether the framework is healthy, resource by resource, and what is wrong with each | | `nxc_versions` | Every installed Nexus Core resource, its version, and its state | | `nxc_status` | Whether the framework is ready, open sessions, and current settings | | `nxc_config_status` | Which resources have registered settings, and how many | | `nxc_zones_status` | Registered zones, and which resource owns each | | `nxc_target_status` | Registered interaction options, whether an inventory provider exists, and how many server actions have nothing the server can check | | `nxc_interact_status` | Registered workflows, how many are in flight, and whether item and reward providers exist | | `nxc_devtools` | What the framework believes, and how many demonstrations registered | | `nxc_devtools demos` | The list of things to try, in an order that builds | **Start with `nxc_versions`.** If the versions do not all come from one compatibility set, fix that before investigating anything else. ### Reading `nxc_health` ``` [nxc_core] framework health: degraded nxc_core serviceable nxc_config serviceable nxc_ui serviceable nxc_zones degraded running on declared defaults; configuration not yet registered nxc_target serviceable ``` | State | What it means | | ------------- | -------------------------------------------------- | | `serviceable` | Working | | `degraded` | Working, with something missing. **Not an alarm** | | `starting` | Waiting for a dependency, named on the line | | `failed` | Not working. The reason is on the line | | `unknown` | The resource did not answer. It may be mid-restart | **The headline is the worst of its parts.** One failed resource means the framework reads failed, whatever the rest say — because a server where sessions are down is not seven-eighths healthy. `degraded` is normal and usually not worth acting on: a resource waiting on a setting that has never been published, or on a resource from a later phase that does not exist yet, is behaving correctly. **`nxc_lib` is absent on purpose.** It is a shared library with no server scripts and no state of its own, so it never registers and has nothing to report. Every other resource loads a copy of it and reports its own health, which is why seven resources appear when you installed eight. **If any other resource you installed is missing from the list**, it never registered. Check that it started at all with `nxc_versions`, and look for `service.announce_failed` in the server log — that line means nxc\_core was not up within thirty seconds of the resource loading. **If every row shows the same name**, the health reports are being labelled from the wrong place. Nothing you can configure causes that; it means a resource is running an old copy of `nxc_lib`. Check `nxc_versions` and reinstall the compatibility set. ## In game | Command | Needs | What it does | | ------------------ | ------------------- | ------------------------------------------------- | | `/nxc_zones_debug` | — | Draws nearby zones. Green when you are inside one | | `/nxcui` | dev mode and an ace | Opens interface test surfaces | ### Enabling the developer commands `/nxcui` exists only when development mode is on, and it is `restricted`, so it needs an ace as well: ```cfg set nxc_dev_mode "true" add_ace group.admin command.nxcui allow add_ace group.admin command.nxc_devtools allow ``` And `ensure nxc_devtools` — it is inert without the two lines above, so it is safe to leave started. Dev mode is about the environment; the ace is about the person. Neither implies the other, and a development server with players on it is a normal thing. ``` /nxcui list every test surface /nxcui confirm opens a dialog that takes the cursor /nxcui focus reports who holds focus right now /nxcui close force-releases focus ``` ### The demonstration site ``` /nxc_devtools_here sets a waypoint to it /nxc_zones_debug draws nearby zones, green when you are inside one ``` Legion Square, which exists on every GTA V server. Run `nxc_devtools demos` for what to try. **`/nxcui focus` is the useful one.** Whether a dialog appears is obvious; whether the cursor was released is not, and the failure mode is a player who cannot move and cannot open the menu that would free them. > **`nxc_dev_mode` must be false in production.** It exposes internal state. `nxc_core` refuses to start a production environment with it enabled. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.nxcframework.net/nexus-core-docs/running-your-server/commands.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.