Configuration Reference

Every option in config.lua, with its default. Nothing here has to be changed for the resource to work.

General

Option	Default
Config.Framework	'auto'	vorp, rsg, redemrp, qbr, standalone, or auto detect
Config.Locale	'en'	en de es fr ja nl ru
Config.Debug	false	State transitions to the console. Leave off in production
Config.PlayerCommands	true	Register /lantern, /lanternplace, /lanterncolour, /lanternbright
Config.TuningCommands	false	Register the nine offset tuning commands

Controls

Option	Default
Controls.UsePrompts	true	Native RDR2 prompts rather than silent key listening
Controls.PromptGroupName	'Lantern'	Title shown above the prompt group
Controls.UseCustomKey	false	Use CustomKey instead of R / B
Controls.CustomKey	'K'	Must exist in Config.Keys
Controls.UseCustomController	false	LT/L2 + D-Pad Right instead of B / Circle
Controls.HoldTime	350	Milliseconds before a hold counts as place / pick up
Controls.TapMaxTime	250	Guard so a hold never also fires the tap
Controls.BlockWeaponWheelWhileStowed	true	Stops the game re-equipping a stowed lantern

Config.Keys and Config.Inputs hold the raw hashes. Leave them alone unless you know what you are changing — see Controls.

Carrying

Option	Default
Config.MountedStorage	true	Stow onto the horse when mounted instead of the rider
Config.KeepLanternOnHorse	false	true leaves it hanging when you dismount
Config.HorseReachDistance	3.5	How close to the horse to take it off from the ground
Config.AdoptExistingStowed	true	Offer to take out a lantern the engine already holds
Config.PedCarryStyle	'auto'	auto, satchel, gunbelt
Config.HorseAttachPoint	'weightbag'	weightbag, saddle, horn, rear
Config.RemoveWeaponOnHorse	true	Saddled lantern leaves the rider — stops a second appearing on the belt

Config.PedBones and Config.HorseAttachPoints define the bones and offsets. See Carrying & attach points.

Placement

Option	Default
Config.LanternPlacement	true	Hold to place and pick up
Config.UnlimitedPlacement	false	false = one per player at a time
Config.MaxPlacedPerPlayer	8	Cap when unlimited. 0 = no cap
Config.MaxPlacedGlobal	200	Server wide cap. 0 = no cap
Config.AllowForeignPickup	true	Players may pick up others' lanterns
Config.RemoveWeaponOnPlace	true	A placed lantern leaves the owner's hands entirely
Config.PlaceDistance	1.8	How far in front a lantern is set down
Config.PickupDistance	2.0	How close to pick one up
Config.RenderDistance	120.0	How far a client draws placed lanterns

See World placement.

Lighting

Option	Default
Config.ColourChanging	true	Colour cycling on / off
Config.Brightness	true	Brightness control on / off
Config.NotifyLightingChanges	true	Show a notification on change
Config.Colours	10 entries	Name and RGB per colour
Config.BrightnessLevels	6 entries	Multiplier per level
Config.MinBrightness	-5
Config.MaxBrightness	0	Default and maximum

See Colour & brightness.

Lanterns and inventory

Option	Default
Config.Lanterns	4 entries	Weapon hash → prop, item, offsets
Config.DefaultLantern	—	Used for any lantern not listed
Inventory.RequireItem	false	Require the item to place
Inventory.ConsumeOnPlace	false	Take the item while it is on the ground

See Lanterns & items.

Persistence

Option	Default
Persistence.Placed	false	Keep placed lanterns across restarts
Persistence.Settings	true	Keep each character's colour and brightness
Persistence.Mode	'json'	json or mysql
Persistence.SaveInterval	120	Seconds between saves

See Persistence.

Notifications

Option	Default
Config.NotifyStyle	'auto'	auto uses your framework, native forces on-screen text, none is silent
Config.NotifyDuration	3000	Milliseconds

Animations

Option	Default
Anims.dict	'mech_pickup@system@rh'
Anims.placeNear	'ground_near'
Anims.placeFar	'ground_far_swipe'
Anims.duration	1200

These are base game animations. Changing them is not recommended.

Options worth changing first

Most servers touch only these:

Config.Locale = 'en'                   -- your language
Config.HorseAttachPoint = 'weightbag'  -- where it hangs on the saddle
Config.KeepLanternOnHorse = false      -- dismount behaviour
Config.UnlimitedPlacement = false      -- one placed lantern, or many
Config.MaxPlacedGlobal = 200           -- server wide cap