For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending
.mdto page URLs; this page is available as Markdown.
Welcome
rx-core is the cross-framework foundation library used by every Rynex script. It abstracts ESX, QBCore, QBox, ox_core, and Standalone behind a single Core API, so scripts work on any setup without forks or compatibility shims.
You only need to install rx-core once. Every other Rynex script depends on it.
What rx-core provides
A global Core table accessible from any Rynex script, with consistent functions for:
- Player identity (citizen ID, source, name, coords)
- Money (cash, bank, black money) across whichever currency system your framework uses
- Jobs and gangs (read and write)
- Permissions and groups
- Inventory items (works with ox_inventory, ESX items, and QB items)
- Weapons (give, remove, ammo)
- Vehicles (spawn, delete)
- Society / job-shared accounts
- Server-to-client callbacks
- Player lifecycle events (loaded, dropped, death, job update)
The same Core function does the right thing on every framework. Your scripts never need to know which framework is installed.
Supported frameworks
- ESX (legacy and modern)
- QBCore
- QBox
- ox_core
- Standalone (limited support — identity and coords only)
Supported inventories
- ox_inventory (preferred when present, regardless of framework)
- ESX items (es_extended built-in)
- QB items (qb-inventory built-in)
What's next
Read the Installation page to set it up. Then check API Reference for the full list of Core functions.
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 by asking a question.
Perform an HTTP GET request on the following URL with the ask and goal query parameters:
GET https://docs.rynexscripts.com/rx-core/welcome.md?ask=<question>&goal=<user_goal>
ask is the immediate question: it should be specific, self-contained, and written in natural language.
goal is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with ask=how do I create an API token, a goal like automate deployments from our CI pipeline lets GitBook tailor the answer to that use case.
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.