> 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/readme.md).

# Nexus Core

A roleplay framework for FiveM servers running GTA V Enhanced.

**Documentation for people who run servers.**

Nexus Core is a roleplay framework for FiveM on **GTA V Enhanced**. It gives you the foundation a roleplay server needs — identity, configuration, interaction, interface — and it assumes nothing about what content you run on top of it.

If you write Lua and want to build resources against it, you want the [developer documentation](https://github.com/NC-Framework/nxc_devdocs) instead.

## Read this first

Nexus Core is **early**. Six of eight foundation resources exist, none of the gameplay resources do, and no version has run on a public server. [Current status](/nexus-core-docs/start-here/status.md) is kept honest about what works and what does not, and it is the page to read before deciding whether this is for you yet.

## Where to go

| You want to                          | Go to                                                                                                                      |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
| Know whether this is ready for you   | [Current status](/nexus-core-docs/start-here/status.md)                                                                    |
| Install it                           | [What you need](/nexus-core-docs/start-here/requirements.md), then [Installing](/nexus-core-docs/start-here/installing.md) |
| Change a setting                     | [Changing settings in game](/nexus-core-docs/configuring/in-game.md)                                                       |
| Work out why something broke         | [When something goes wrong](/nexus-core-docs/running-your-server/troubleshooting.md)                                       |
| Move to a newer version              | [Upgrading](/nexus-core-docs/start-here/upgrading.md)                                                                      |
| Explain the controls to your players | [For players](/nexus-core-docs/for-players/interacting.md)                                                                 |

## Two things that are different here

**Almost nothing is configured by editing files.** Settings live in the database and are changed in game, with history and a rollback. Only what is needed before a database connection exists lives in `server.cfg` — the connection string itself, and a handful of others. See [How configuration works](/nexus-core-docs/configuring/how-it-works.md).

**Resources are released together as a compatibility set.** Installing versions from different sets is unsupported, because the framework's own pieces depend on each other's contracts. The set is what tells you which versions belong together. See [Compatibility sets](/nexus-core-docs/reference/compatibility-sets.md).


---

# 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/readme.md?ask=<question>&goal=<endgoal>
```

`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.