Documentation

Everything you need to get started with RedM Bot

Getting Started

Step 1: Login with Discord

Click the "Login with Discord" button in the navigation to authenticate with your Discord account.

Step 2: Add Bot to Your Server

  1. After logging in, you'll be redirected to your dashboard
  2. Click "Add Bot to Server" to invite the bot to your Discord server
  3. Select the server you want to add the bot to
  4. Authorize the bot with the required permissions

Step 3: Configure Your Server

Once the bot is added, it will appear in your dashboard. Click "Configure Now" to set up your RedM server connection.

⚠️ Important: The Frsk_Discord-Server RedM resource is required for the bot to communicate with your server. Without this resource installed and running on your RedM server, none of the bot commands will work. See the RedM Setup section below for installation instructions.

Dashboard Setup

Configuring Your RedM Server

From your dashboard, you'll need to provide:

  • RedM Server URL: Your server IP and port (e.g., http://123.45.67.89:30120)
  • Resource Name: Default is Frsk_Discord-Server (change if you renamed it)
  • Admin Role: Discord role that can use admin commands (optional)
  • Log Channel: Discord channel for bot logs (optional)

Finding Your Server Details

Server IP and Port:

  • Use your server's game server port, not the txAdmin/web panel port
  • ZAP Hosting Users: Use your game server port (NOT the txAdmin port, which will return HTML errors)
  • Self-Hosted/Localhost: Forward your game port in router settings and use your public IP address (not localhost)
  • Format: http://your-ip:port (e.g., http://123.45.67.89:30120)

Discord Role/Channel IDs:

  • Enable Developer Mode in Discord Settings → Advanced
  • Right-click on a role → Copy Role ID
  • Right-click on a channel → Copy Channel ID

RedM Server Setup

📦 Purchase Required: The Frsk_Discord-Server resource must be purchased separately from our Tebex store or CFX.re. This encrypted resource acts as the bridge between the Discord bot and your RedM server.

Installing the Resource

  1. Purchase and download the Frsk_Discord-Server resource from Tebex/CFX
  2. Extract and place it in your resources/[frsk]/ folder
  3. Add to your server.cfg:
ensure Frsk_Discord-Server
  1. Restart your RedM server
  2. Check console for: [Discord Bridge] Discord Bridge started successfully

Verifying the Connection

Once configured, use the /testconnection command in Discord to verify the bot can communicate with your RedM server.

You should see a success message with your server name and framework type (VORP or RSG).

Commands

Admin Commands

These commands require the configured admin role:

/giveitem

Give an item to a player

player_id Server ID of the player
item_name Database name of the item
amount Quantity (default: 1)

/giveweapon

Give a weapon to a player

player_id Server ID of the player
weapon_name Weapon hash name (e.g., WEAPON_REVOLVER_CATTLEMAN, WEAPON_REPEATER_CARBINE, WEAPON_RIFLE_VARMINT)

/givemoney

Give money to a player

player_id Server ID of the player
money_type cash or gold
amount Amount to give

/takemoney

Take money from a player

player_id Server ID of the player
money_type cash or gold
amount Amount to take

/kick

Kick a player from the server

player_id Server ID of the player
reason Reason for kick (optional)

/announce

Send a server-wide announcement

message Announcement message

/teleport

Teleport a player to a preset location

player_id Server ID of the player
location Choose: Valentine, Saint Denis, Tumbleweed, or Blackwater

/checkjob

Check a player's job information

player_id Server ID of the player (optional if identifier is provided)
identifier Player identifier like steam:110000... (optional if player_id is provided)

/setjob

Set a player's job, grade, and title

Note for RSG Framework: RSG uses location-based job names. For law enforcement, use 'vallaw' (Valentine), 'rholaw' (Rhodes), or 'blklaw' (Blackwater) instead of 'sheriff'. Grade 2 is typically Sheriff, Grade 1 is Deputy.

player_id Server ID of the player
job Job ID - VORP: (sheriff, doctor, unemployed) | RSG: (vallaw, rholaw, blklaw, etc.)
jobgrade Job grade/rank (e.g., 0, 1, 2, 3) - RSG law: 2=Sheriff, 1=Deputy
joblabel Job label/title (e.g., Sheriff, Deputy, Doctor)

/res

Revive a dead player instantly

player_id Server ID of the player

Player Commands

These commands can be used by anyone:

/players

View all online players

/playerinfo

Get detailed information about a player

player_id Server ID of the player

/inventory

View a player's inventory

player_id Server ID of the player

/characters

View all characters for a player

identifier Player identifier (e.g., steam:110000xxxxx)

/serverstatus

Check RedM server status

/testconnection

Test connection to RedM server

Framework Support

VORP Framework

Full integration with VORP Core including:

  • Inventory management
  • Money system (cash and gold)
  • Character data
  • Weapon tracking

RSG Framework

Full integration with RSG Core including:

  • Inventory management (via rsg-inventory exports)
  • Money system (cash, gold, and multiple bank accounts)
  • Character data (from players table with JSON parsing)
  • Weapon tracking (as inventory items with quality/serial)
  • Job management (with location-based naming conventions)

Note: RSG framework is automatically detected on server startup. No manual configuration needed.

Troubleshooting

Bot not responding to commands

  • Verify you've configured the bot in the dashboard
  • Check that you've set the admin role correctly (if using admin commands)
  • Wait a few minutes after adding the bot for commands to sync
  • Try using /testconnection to verify bot can reach your server

Cannot connect to RedM server

  • Use /testconnection command to see detailed error messages
  • Verify your RedM Server URL in the dashboard is correct (include http:// and port)
  • Ensure Frsk_Discord-Server resource is started on your RedM server (check console for startup messages)
  • ZAP Hosting users: Make sure you're using the game server port, NOT the txAdmin port
  • Self-hosted/localhost users: Forward your game port in router settings and use your public IP address (not localhost or 127.0.0.1)

Getting "text/html" or HTML errors

  • You're likely hitting the txAdmin/web panel port instead of your game server port
  • Verify the port in your dashboard matches your RedM server's game port, not the txAdmin/web panel port
  • Check your hosting provider's documentation for the correct game server port

Commands return errors

  • Check the RedM server console for error messages
  • Ensure the framework (VORP/RSG) is auto-detected (check console for "Auto-detected [framework]")
  • Verify player IDs are correct (use /players to see online players)
  • Make sure the resource name in dashboard matches the actual resource folder name

Dashboard shows "No servers found"

  • Make sure you've added the bot to your Discord server first
  • You must have "Manage Server" permission in the Discord server to see it
  • Try logging out and logging back in
  • Wait a few minutes for Discord to sync server list

Resource not starting

  • Check RedM console for error messages in red
  • Verify the resource is in resources/[frsk]/Frsk_Discord-Server/
  • Check that fxmanifest.lua, config.lua, and server.lua exist
  • Try: refresh then ensure Frsk_Discord-Server in console

Request a Feature

So we can follow up with you if needed

Be as detailed as possible