World - JRS Core

World features: towns, travel, teleports, canoes and more.

This folder has 6 scripts. Pick a script in the tabs below.

Free (included in JRS Core) jrs_canoe

JRS Core canoes - rent canoes from riverside carpenters and carry them

Exports

GetCanoeEntityObject, IsCarryingCanoe, IsModelCanoe, OpenCanoeRentingShop

config.lua - 13 options#

General

Setting	Default	What it does
`Language`	`"en"`	'en' or 'ar'
`PromptAction`	`table`	Text shown to the player for prompt action. Change it to translate or rebrand.
`CanoeActionPrompt`	`table`	Text shown to the player for canoe action prompt. Change it to translate or rebrand.
`NPCRenderingSpawnDistance`	`50.0`	Distance in game units that applies to npc rendering spawn distance.
`RemoveStaminaWhileCarrying`	`table`	Remove stamina while carrying a canoe?
`SetPedMaxMoveBlendRatio`	`0.8`	0.0 - 1.0
`PickupCommand`	`"pickupcanoe"`	The command to pickup the closest canoe.
`DropCommand`	`"dropcanoe"`	The command to drop the closest canoe.
`UseInteractPrompt`	`false`	true = interact through the JRS interaction prompt instead of the classic prompts
`Models`	`table`	Insert all the canoe models here (You might also have custom canoe vehicle object) DO NOT EDIT WITHOUT KNOWLEDGE.
`ModelsTargetOptions`	`table`	The target options are for the JRS interaction prompt support only when targetting a canoe from Config.Models
`Stores`	`table`	Table of stores entries. Add, remove or edit entries following the examples in the file.
↳ `RoanokeValley`	`table`	Table of roanoke valley entries. Add, remove or edit entries following the examples in the file.

Free (included in JRS Core) jrs_hotair

JRS Core hot air balloons - hire, fly and carry passengers

Commands

config.lua - 15 options#

General

Setting	Default	What it does
`Language`	`"en"`	'en' or 'ar'
`Model`	`"hotAirBalloon01"`	Balloon vehicle model
`HirePrice`	`50`	Flat hire fee (cash). No timers, no cooldowns, no fuel.
`PassengerOffsets`	`table`	Balloon basket seats (offsets relative to the balloon entity) pilot uses the driver seat (-1), passengers attach at these offsets
`CruiseSpeed`	`0.05`	drift added per tick
`BoostSpeed`	`0.15`	drift added per tick while boost held
`MaxAltitudeAGL`	`150.0`	ceiling above ground level
`StoreMaxSpeed`	`3.0`	m/s, balloon must be near-stationary to store
`StoreMaxHeightAGL`	`4.0`	must be close to the ground to store
`BoardMaxSpeed`	`3.0`	same limits for boarding / piloting
`BoardMaxHeightAGL`	`4.0`	Upper limit for board max height agl.
`TargetDistance`	`6.0`	prompt distance (balloon is a large entity)
`StorageMaxWeight`	`100000`	Balloon storage (JRS storage per character, slots)
`StorageMaxSlots`	`20`	Upper limit for storage max slots.
`Docks`	`table`	Add as many docks as you like, one NPC + blip + target is created per entry automatically. Ground Z is resolved at runtime.

Free (included in JRS Core) jrs_npcs

JRS Core ambient NPCs - place townsfolk with scenarios, blips and optional voice lines

config.lua - 3 options#

General

Setting	Default	What it does
`SpawnDistance`	`40.0`	NPC appears inside this radius, disappears outside it
`FadeIn`	`true`	Switch for fade in: true = on, false = off (default true).
`Peds`	`table`	Game model or entity used for peds.

Free (included in JRS Core) jrs_radius

A radius player culling script for jrs core framework

Free (included in JRS Core) jrs_teleports

JRS Core teleports - enter / leave doors that use a teleport, optionally job-locked

config.lua - 3 options#

General

Setting	Default	What it does
`Language`	`"en"`	'en' or 'ar'
`PromptKey`	`0xCEFD9220`	E (hold)
`Locations`	`table`	Each entry: label, enter / exit = vector4(x, y, z, heading), distance, jobs = { 'job' } or false

Free (included in JRS Core) jrs_track

JRS Core horse race tracks - build checkpoint routes, save them and race

Commands

Database tables

horse_race_tracks

shared/config.lua - 8 options#

General

Setting	Default	What it does
`Locale`	`"en"`	'en' or 'ar'

url is the fallback webhook used for any event that doesn't set its own

Setting	Default	What it does
↳ `enabled`	`false`	master switch; everything below is inert until this is true
↳ `url`	`""`	e.g. 'https://discord.com/api/webhooks/XXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
↳ `botName`	`"JRS-Track"`	Text shown to the player for bot name. Change it to translate or rebrand.
↳ `botAvatar`	`""`	optional icon url shown as the webhook's avatar
↳ `footer`	`"JRS-Track Logs"`	Setting for footer.
↳ `minIntervalMs`	`350`	Minimum time (ms) between two posts to the same webhook URL. Discord rate-limits webhooks; this keeps a burst of events (e.g. everyone finishing at once) from tripping it.
↳ `events`	`table`	Table of events entries. Add, remove or edit entries following the examples in the file.