Skip to content

RedM Lantern Installation

Requirements

None. There are no dependencies, no ox_lib, no NUI, no streamed assets and no SQL to import.

OptionalWhen
oxmysqlOnly if you set Config.Persistence.Mode = 'mysql'. See Persistence
A frameworkVORP, RSG, RedEM:RP or QBR are detected automatically if running. Not required

Install

1. Extract the rm_Lantern folder into your resources directory. A bracketed category folder is fine:

resources/[rm]/rm_Lantern/

2. Ensure it in server.cfg:

cfg
ensure rm_Lantern

Mind the capital L

The folder is rm_Lantern, not rm_lantern. Linux servers are case-sensitive, so a mismatch between the folder name and your ensure line will simply not start.

Note that the admin ace is spelled lowercaserm_lantern.admin. That is not a typo; they are genuinely different strings.

If you use a framework, start it after your core so detection works on the first try. It recovers either way, but the startup log will be cleaner.

3. Restart the server.

On start the console prints which framework was detected:

[rm_Lantern] framework: vorp

standalone here is not an error — it means no supported core was running, and the resource works perfectly well without one.

First test

  1. Give yourself a lantern. On a framework that means the item or weapon your server already uses. Standalone, use your admin tool to give weapon_melee_lantern or weapon_melee_davy_lantern.
  2. Equip it so it is in your hand.
  3. A prompt appears. Tap R.

The lantern moves to your belt and keeps burning. Tap R again to take it back, or hold R to set it on the ground.

Test at night

In daylight the light is nearly invisible and it looks like nothing is happening. This is the single most common "it isn't working" report.

Configuration

Open config.lua. Everything is commented inline, and nothing has to be changed for the resource to work.

The three you are most likely to want:

lua
Config.Locale = 'en'                  -- en de es fr ja nl ru
Config.HorseAttachPoint = 'weightbag' -- where it hangs on the saddle
Config.KeepLanternOnHorse = false     -- does dismounting bring it with you

Full reference: Configuration.

Updating

Replace the whole folder, then re-apply your config.lua changes.

Compare, don't paste wholesale

Keep a copy of your edited config.lua before overwriting. New versions may add options, so compare rather than pasting the old file back — a missing option falls back to nil and may disable a feature silently.

Uninstalling

Remove ensure rm_Lantern from server.cfg and delete the folder.

If you enabled JSON persistence, placed_lanterns.json and lantern_settings.json go with it. If you used MySQL, drop the rm_lantern_placed table by hand — the resource does not delete it for you.

Documentation for RedMorrow. Scripts are licensed per server — redistribution is not permitted.