<!-- fivemad.com, Markdown source of https://fivemad.com/redm/docs -->
> Source: https://fivemad.com/redm/docs
> Every page below is also available as Markdown: add .md to its URL.
> Site map for assistants: https://fivemad.com/redm/llms.txt

# fivemad RedM documentation

How to set up a RedM server, write and port resources for Red Dead Redemption 2, and use every fivemad RedM tool.

## AI and API

- [Using fivemad RedM with an AI assistant](https://fivemad.com/redm/docs/ai.md): Read any RedM docs page as Markdown, hand a page to ChatGPT, Claude or Cursor in one click, and point an assistant at the whole RedM side with /redm/llms.txt.
- [RedM API](https://fivemad.com/redm/docs/ai/api.md): Look up RDR2 joaat hashes, search RDR2's game text, search the RedM docs and fetch the RedM datasets over plain HTTP, with examples in Lua, JavaScript, Python and curl.

## Getting started

- [What RedM is](https://fivemad.com/redm/docs/getting-started.md): RedM is the Cfx.re multiplayer platform for Red Dead Redemption 2 on PC. What it shares with FiveM, what it does not, and where to start.
- [The fxmanifest and rdr3_warning](https://fivemad.com/redm/docs/getting-started/fxmanifest.md): A RedM resource declares game 'rdr3' and carries the rdr3_warning line word for word, or it does not start. A minimal manifest you can copy.
- [RedM for a FiveM script author](https://fivemad.com/redm/docs/getting-started/differences.md): What changes when you write for RedM instead of FiveM: natives by hash, controls as hashes, peds that need an outfit, prompts, blips by style, and RDR2 game data.

## Server setup

- [Set up a RedM server](https://fivemad.com/redm/docs/server-setup.md): A RedM server is FXServer with set gamename rdr3 and the enforced RDR2 build. The artifacts, the server.cfg lines, the stock resources and txAdmin.

## Frameworks

- [VORP, RSG or standalone](https://fivemad.com/redm/docs/frameworks.md): The RedM frameworks that are maintained today, VORP and RSG, how their data is laid out, their licenses, and when to go standalone instead.

## Porting from FiveM

- [Porting a FiveM resource to RedM](https://fivemad.com/redm/docs/porting.md): What changes when a FiveM resource moves to RedM, in the order you hit it: the game key, natives by hash, controls, peds and outfits, prompts, blips and game data.

## Tools

- [RedM tool guides](https://fivemad.com/redm/docs/tools.md): One guide per fivemad RedM tool, plus the RedM Files and RedM Assets pages: what each is for, its options, and what to do with what it gives you.
- [server.cfg Generator](https://fivemad.com/redm/docs/tools/server-cfg-generator.md): Fill in a form and get a RedM server.cfg with set gamename rdr3, the enforced build and the resource lists of the default, VORP and RSG recipes.
- [Prompt Builder](https://fivemad.com/redm/docs/tools/prompt-builder.md): Build a group of RDR2 prompts (press, hold or mash) on the game's own input actions and hold timings, try them in a preview, and download the Lua.
- [Loading Screen Generator](https://fivemad.com/redm/docs/tools/loading-screen.md): Make a RedM loading screen resource with your title, tips, background image or video and music, a real progress bar and log line, downloaded as a zip.
- [Photo Mode Converter](https://fivemad.com/redm/docs/tools/photo-converter.md): Turn RDR2 photo mode files (PRDR) into normal JPEG pictures in your browser, with where and when each photo was taken. Nothing is uploaded.
- [Resource Conflict Checker](https://fivemad.com/redm/docs/tools/resource-conflicts.md): Drop several RedM resources at once and see duplicate stream files, replaced RDR2 files, repeated data_file lines and manifest mistakes.
- [Item Generator](https://fivemad.com/redm/docs/tools/item-generator.md): Pick RDR2 items by their game icon, edit names, labels and weights, and get the VORP items SQL or the RSG items.lua rows with the icons as PNG.
- [Hash Calculator](https://fivemad.com/redm/docs/tools/hash-calculator.md): Turn RDR2 names into joaat hashes one at a time or as a list, and look a hash up against the names and game text read from RDR2's own files.
- [Game Text Search](https://fivemad.com/redm/docs/tools/text-search.md): Search every line of RDR2's English text by words, label hash or key, see how the game stores it, and copy the Lua that replaces it in RedM.
- [Interactive Map](https://fivemad.com/redm/docs/tools/map.md): Browse the RDR2 map in 2D or 3D, jump to a town or a lake, show the game's zone outlines and read the world position and zones under your cursor.
- [Coords Picker](https://fivemad.com/redm/docs/tools/coords-picker.md): Click the RDR2 map for x, y, z and a heading, copy them as vector3, vector4 or JSON, and get the state, district, town and water zone at that spot.
- [Blip Placer](https://fivemad.com/redm/docs/tools/blip-placer.md): Place blips on the RDR2 map with the game's own blip styles and icons, then copy a Lua client script, a vorp_stores Blip block or rsg-shops blip fields.
- [Blip Styles](https://fivemad.com/redm/docs/tools/blip-styles.md): Browse all 620 blip styles of RDR2's blipdata.ymt: the icon and colour each one ends up with, the styles it inherits from, and the Lua to create a blip with it.
- [Door Finder](https://fivemad.com/redm/docs/tools/door-finder.md): Find any RDR2 door on the map, get its door hash and position, and copy it as a vorp_doorlocks or rsg-doorlock config entry or as Lua that locks it.
- [Imap Toggler](https://fivemad.com/redm/docs/tools/imap-toggler.md): Find RDR2 imaps (ymaps) by clicking the map, by name or by hash, see which only load when a script asks, and copy Lua that loads or removes them.
- [Train Tracks](https://fivemad.com/redm/docs/tools/train-tracks.md): Every RDR2 railway, trolley, mine cart and riverboat track on the map, with its junctions, its config group, the trains it runs and Lua to spawn one.
- [Interiors](https://fivemad.com/redm/docs/tools/interiors.md): Every interior placed in the RDR2 world, on the map and as a list: rooms, portals, entity sets, the imap it needs, and Lua to switch its entity sets.
- [Folders to YTD](https://fivemad.com/redm/docs/tools/folders-to-ytd.md): Drop folders of images and get one RDR2 texture dictionary per folder, compressed and mipmapped in your browser, packed as a RedM resource.
- [Blip Replacer](https://fivemad.com/redm/docs/tools/blip-replacer.md): Swap RDR2 map blip icons for your own pictures and download a RedM resource with the rebuilt blip dictionaries, every stock icon carried over.
- [Map Editor](https://fivemad.com/redm/docs/tools/map-editor.md): Draw roads, railways, borders, buildings, water, labels and pictures on RDR2's in-game map, mainland or Guarma, and download the rebuilt map tiles as a RedM resource.
- [RedM Files](https://fivemad.com/redm/docs/tools/files.md): Keep RDR2 and RedM files in your browser. Each file is identified from its bytes, its contents are read, and it points you at the RedM tool that opens it.
- [RedM Assets](https://fivemad.com/redm/docs/tools/assets.md): Browse RDR2's blips, peds, horses, weapons, vehicles, items, documents, scenarios, controls, timecycles, weathers, zones, interiors, imaps and scripts with hashes and Lua.
