Installation
Common requirements
Regardless of the framework, the following are required:
- oxmysql — database access.
- A working MySQL database.
- vorp_menu — in-game menu engine (used on both frameworks).
The resource then adapts to the server's framework (VORP or RSG) via the Config.Framework option. Framework-specific dependencies are listed below.
Dependencies per framework
The resource detects or selects the framework, then automatically routes notifications, inventory, currencies and admin detection to the matching ecosystem.
VORP server
| Role | Resource |
|---|---|
| Core | vorp_core |
| Menus | vorp_menu |
| Inventory (default) | vorp_inventory |
| Database | oxmysql |
Related configuration:
Config.Framework = "vorp"
Config.Inventory = "auto" -- resolves to vorp_inventoryRecommended order in server.cfg:
ensure oxmysql
ensure vorp_core
ensure vorp_menu
ensure vorp_inventory
ensure josk_arenaRSG server
| Role | Resource |
|---|---|
| Core | rsg-core |
| Notifications | ox_lib |
| Inventory (default) | ox_inventory |
| Menus | vorp_menu |
| Database | oxmysql |
On an RSG server,
ox_libandox_inventoryare usually already present (shipped withrsg-core).
Related configuration:
Config.Framework = "rsg"
Config.Inventory = "auto" -- resolves to ox_inventoryRecommended order in server.cfg:
ensure oxmysql
ensure ox_lib
ensure rsg-core
ensure ox_inventory
ensure vorp_menu
ensure josk_arenaOn RSG, access to the arena builder relies on an ace permission (groups are not exposed client-side). Example to add to server.cfg:
add_ace group.admin josk_arena.builder allowSetup
- Place the
josk_arenafolder in the server'sresources/directory. - Set
Config.Framework(and, if needed,Config.Inventory) inconfig/arena_config.lua. - Add the resource to
server.cfg, after its dependencies (see the examples above). - Start (or restart) the server.
Database: no manual import is needed. The required tables are set up automatically on first launch.
Inventory items (optional)
Depending on the configuration, two items may be used. They must exist in the framework's inventory (to be created on the database / inventory-configuration side):
boxing_tablet— opens the management tablet when item-opening is enabled (Config.Tablet.openMode = "item"). In command mode, this item is unused.josk_item_contract— paper contract handed out when a stable contract is signed, whenServerConfig.Contracts.issueOnSign = true. If the item does not exist, signing continues without error and the contract stays purely digital.
Verification
- In-game, with an administrator account, open the builder via
/arena_builderand create a first arena. - Open the management tablet (
/boxingor theboxing_tabletitem, depending on the configuration). - Check that the arena appears on the map and that the welcome NPC is correctly placed.
Troubleshooting
| Symptom | Lead |
|---|---|
| The resource doesn't route to the right framework | Check Config.Framework (or use "auto") and the start order in server.cfg. |
| The tablet won't open from an item | Make sure the boxing_tablet item exists in the inventory and that Config.Tablet.openMode = "item". |
/arena_builder has no effect | On VORP, the group must be in Config.Builder.adminGroups; on RSG, add the josk_arena.builder ace permission. |
| No notifications appear (RSG) | Make sure ox_lib is started. |
| Paper contract not handed out | The josk_item_contract item must exist and issueOnSign must be true. |
| No Discord announcements | Set the webhook URL and Config.Discord.enabled = true. |