RedM Guidebook

An in-game almanac. Staff write chapters and entries from inside the game; players read them in a leather-bound overlay; signposts put a prompt in the world that opens the right page where it matters.

No page list in a config file. No restart to publish.

VORP RSG Core RedEM:RP Standalone

The 60-second version

1. Add it to server.cfg, after your framework:

   ensure rm_guidebook

2. Grant yourself staff:

   add_ace group.admin rm_guidebook.press allow
   add_principal identifier.license:XXXXXXXXXXXXXXXX group.admin

3. Join the game and press F7.

That is genuinely all. The three tables are created on first start and a welcome chapter is written, so the almanac is never empty the first time someone opens it.

Step 2 is the one people skip

Then they open a ticket because /press refuses them. Both lines are needed — the add_principal is the one that gets forgotten.

What it does

An almanac. Chapters hold entries, entries hold the writing. Readers open it with a key or /almanac, search it, size the text to their screen and pick one of three bindings. Their choices are remembered on their own machine.

A press. Staff open /press and write. A real editor — headings, bold, lists, quotations, pictures they can drag to size and align, YouTube, a directions button that marks a place on the reader's map. Saved to the database and pushed to every connected player immediately.

Signposts. A world marker with a floating title, an optional map blip and ground marker, and a prompt that opens an entry — or carries its own text, for a notice nailed to a post that belongs nowhere else. Staff place one by standing where they want it.

Job gates. Any chapter, entry or signpost can be limited to certain jobs at a minimum grade. The rule runs on the server before a body is handed over, and on the client before a signpost is drawn — so a restricted leaf is neither shown nor readable.

Search. Titles and bodies, scored, with the surrounding sentence quoted under each result and the query marked in it.

For other scripts. Exports to open the almanac for a player, write a chapter or entry, and check whether someone is staff — so a script can ship its own page of documentation and have it appear the first time it starts.

Requirements

oxmysql	Required, and the only library this resource needs
MySQL / MariaDB	Three tables, created on first start
A framework	Optional. VORP, RSG Core or RedEM:RP, probed at start-up

There is deliberately no framework dependency in the manifest — naming one would stop the resource starting on the other three. Nothing is fetched from the internet at runtime: the overlay, the artwork and the four typefaces are all served from the resource itself.

Editions

Both are sold from the same product page.

Edition	Price	Code access
Open Source	$86.54	The whole tree, plus web/src/ and tools/, which the escrow build does not ship at all
RedM Escrow	$24.78	CFX Escrow — config/, local/, locales/, install/, docs/ and server/demo.lua stay editable

The resource calls them Standard and Source

EDITION.txt in the folder you unzip says which you have, in the first line. Or check client/util.lua — readable Lua means Source, a wall of encrypted text means Standard, and that is working as intended.

Both editions are the same resource with the same features and the same updates. Only two things in this documentation need the Open Source edition: building the overlay and the test tooling.

You never edit config/

Write what you want to change into local/overrides.lua. It is folded over the whole settings tree before a single client or server file runs, and an update never touches it.

RmGuidebook.Local = {
    bridge  = { framework = 'vorp' },
    overlay = { title = 'The Blackwater Gazette', theme = 'midnight' },
    keys    = { open = 'F9' },
}

Anything you change in config/, locales/ or the code will be overwritten — updates ship the resource whole, not as a patch.

One command solves most problems

/almanac_debug

Prints a self-check to the server console: which framework bound, what the database holds, whether the overlay is built, what the caller may do — and a list of things that are perfectly legal but almost certainly not what you meant, like a standalone server with the job gate still on.

Run it before opening a ticket. Pasting its output is the fastest way to get an answer.

Documentation

Start here

Page	What's in it
Installation	Three steps, the database, staff, and coming from another guidebook
Commands & keys	Every command, the key, and what the console can run
Configuration	Every setting and what changing it costs you

Writing

Page	What's in it
The press	Chapters, entries, the editor, images and directions buttons
Signposts	Placing one, blips, markers, routes
Permissions & job gates	The three staff checks, the eight verbs, and access blocks

Running it

Page	What's in it
Frameworks	VORP, RSG, RedEM:RP, standalone — and what differs on each
Database	The three tables, the schema file, migrating a legacy guidebook
Languages	Four shipped, and adding a fifth
Developer API	Exports, events, and adding a framework adapter

When something is wrong

Page	What's in it
Troubleshooting	Symptom → cause → fix
FAQ	The questions that come up before buying

Support

• 💬 Discord: https://discord.gg/w4Ew4k3Exn
• 🛒 Store: https://redmorrow.com/products/redm-guidebook

Bring the output of /almanac_debug, which framework and edition you are on, and what you expected versus what happened.

Everything you write with the press is yours. RedMorrow claims nothing over your database.

Version 1.0.0.