RedM Guidebook Script: Rules, Guides & Job-Locked Pages

An in-game guidebook for RedM. Your staff write chapters and pages from inside the game, players read them in a leather-bound book, and signposts out in the world open the right page where it matters. Job-locked sections, search that returns the sentence around each hit, and routes drawn on the reader's map. VORP, RSG Core, RedEM:RP or fully standalone.

24.78 USD

Your server has rules and nobody reads them, because they are in a Discord channel three months up, and no new player is scrolling that far to find them. This RedM guidebook script puts your server rules in the game, in a leather-bound book your players open with one key.

Your staff write it from inside the game. Type /press and you get a proper editor: headings, four typefaces, ink colour, highlighting, lists, quotes, pictures you resize by dragging a corner, YouTube, and website embeds if you want them. Hit save and everyone already online has it. No config file, no upload, no restart.

Signposts put the page where it matters. Stand on the spot, press Use my position, and choose what it carries: a title that fades in at a distance you pick, a map blip, a marker on the ground, and a prompt bound to the player's own interact key. Walk up, press it, the right page opens. A signpost can also carry its own text, for a notice that belongs to no chapter.

Lock a page to a job and it stays locked. Sheriff procedures, a doctor's reference, a gang's own page, limited to a job at a grade or above. The check runs on the server, so a player who should not see it cannot open it, cannot find it in search, and never sees the signpost at all.

Works on any RedM server - VORP, RSG Core, RedEM:RP or fully standalone, worked out at start-up with no flag to set. oxmysql is required even standalone, because the book lives in the database. That is exactly what lets pages save live instead of sitting in a config file.

Commands

  • /almanac - open the book, or your own key, F7 by default
  • /press - the authoring overlay, staff only
  • /almanac_hand - hand the book to a player, opened at a page
  • /almanac_route - draw the way to a signpost on your map
  • /almanac_resync - re-read everything from the database and push it out
  • /almanac_migrate - import from an older guidebook in the same database, never overwriting
  • /almanac_demo - fill it with a worked example, and clear to remove it
  • /almanac_debug - print a full self-check to the server console

Every command name is configurable.

What you get. Instant delivery, free updates for life, and one purchase covering every server you own with no player limit. config, local, locales, install and docs stay readable and editable, and a Source Edition is available with the complete unencrypted code including the React overlay. Everything you write stays yours.

Product Features

Search That Answers

Type a word and the results come back with the sentence around each hit and the word marked inside it, so a reader finds the answer rather than the page that might hold it. It only ever searches what that player is allowed to see.

Unlisted Pages

A page can be kept out of the index while staying reachable by signpost or by a direct link. Useful for anything you want to hand out rather than advertise.

Gated by Job and Grade

A gate applies to a whole chapter, a single page or a signpost, and it is set to a job at a grade or above rather than a flat yes or no, so a deputy and a sheriff can be given different pages of the same book.

Directions on the Page

Drop a directions button into an entry, press Use my position while standing where you mean, and a reader who presses it gets the route drawn on their map. /almanac_route does the same for a signpost.

Three Bindings

Leather, parchment or midnight, plus a text size slider. Each player picks their own and the choice is kept on their machine rather than in your database.

Four Languages

English, German, Spanish and French. One file per language covers both what the server says in chat and every word of the interface, and a missing line falls back to English rather than showing a raw key.

Light and Quiet

Readers download about 200 kB of overlay, and the editor is a separate chunk fetched only by staff who open the press. The client sleeps between signpost scans and draws nothing unless you are near a post or reading.

Staff Clears Three Ways

A server ACE, your framework's admin group, or the console, and any one of them passing is enough. The three frameworks disagree about what an administrator is, so relying on only one of them breaks on the other two.

Exports on Both Sides

Server side: open, openPress, ensure, commit, strike, find, list and isStaff. Client side: open, openEntry, isOpen and route. Events cover the same verbs where an export does not suit, so a tutorial resource can open a page and a job script can write one.

A Self-Check Command

/almanac_debug prints which framework it bound, what the database holds, whether the overlay is built and what the caller may do, plus a list of things that are legal but probably not what you meant, like a standalone server with the job gate still on.

Bring Pages From Another Book

/almanac_migrate copies chapters and entries out of an older guidebook's tables when they sit in the same database. It never overwrites, so a page already in the almanac is left alone and running it twice is safe.

A Worked Example to Start From

/almanac_demo fills the book with a real example across six towns so you can see the shape of it before writing your own, and clear takes it all back out again.