Installation
📋 Requirements
| Resource | |
|---|---|
| oxmysql | Required |
RSG: rsg-core and rsg-inventory | |
VORP: vorp_core and vorp_inventory | |
| OneSync | Required. The server checks carcasses and player positions |
The framework is detected automatically (Config.Framework = 'auto'). You can force it with 'rsg' or 'vorp'.
🚀 Installing
- Drop the
kartik-huntingfolder into your resources. - Start it after oxmysql, your framework and your inventory in
server.cfg:
ensure oxmysql
ensure rsg-core # or vorp_core
ensure rsg-inventory # or vorp_inventory
ensure kartik-hunting- Restart your server. Items are registered on start (see Items).
- On VORP, restart once more so vorp_inventory loads the new items.
Stop other hunting scripts that pay for pelts or skinning (a vorp_hunting or rsg-hunting, for example). Otherwise the same animal pays twice.
If the console prints "No framework found", your framework is starting after kartik-hunting. Move its ensure line above.
💾 Database
Nothing to import. These tables are created on the first start:
| Table | What it holds |
|---|---|
kartik_hunting_hunters | Reputation and hunting stats (ledger and compendium) per character |
kartik_hunting_contracts | Contracts each hunter has taken, with their progress |
kartik_hunting_traps | Traps set in the world, so they survive restarts |
kartik_hunting_stowed | Carcasses tied on horses and loaded on wagons |
👑 Admin access
Admin commands need the ace in Config.Admin.ace, which is command by default. txAdmin and server admins already have it. See Commands.
💬 Optional: Discord logs
Set Config.Logs.enabled = true and add your webhook to server.cfg:
set kht_discord_webhook "https://discord.com/api/webhooks/..."Pick which events are sent in Config.Logs.events. See Configuration.
✅ First steps
- Join, type
/journaland look around the ledger. - Ride out into the wild, crouch and hold the search prompt (or type
/track). - Follow the signs, take a clean shot with the right weapon and skin the animal.
- Sell at a butcher or trapper, and pick up a contract from their board.
- Open
shared/config.luaand set your theme, title and currency inConfig.UI.
🖌️ Editing the UI
The UI source is in source/ (React, Vite, Tailwind). The built files in web/ are what the game loads.
cd source
npm install
npm run start # browser preview with mock data at http://localhost:5173
npm run build # writes web/Preview pages: #journal, #trader, #result, #clue, #hud. Add ?theme=paper or ?lang=de to see another theme or language.