Showcase Video

RanchWork Script - BRB Mailbox

BRB Mailbox is an advanced RedM telegram and carrier pigeon mail system with a western-themed NUI, private address book codes, post office letters, pigeon delivery, offline letter notifications, and immersive reading animations.

Built for VORP Core and RSG Core, selectable directly from the config, and designed around character identity, address privacy, and roleplay-friendly communication.

Features

• VORP Core and RSG Core support

• Config-based framework selection

• VORP Inventory and RSG Inventory usable item support

• Western-themed telegram paper NUI

• Post office NPCs and blips

• Native prompt interaction system

• Incoming and outgoing letter boxes

• Read state and letter deletion

• Reply flow for received letters

• Private address code system

• Players are not listed publicly

• Address book records are added by shared address code

• Address book alias, notes, and favorite support

• Character identity based contact ownership

• carrier_pigeon usable item

• Pigeon letter mode opened from item usage

• Carrier pigeon purchase screen

• Configurable pigeon purchase amount and price

• Pigeons can be limited to address book contacts only

• Pigeon release animation after sending a letter

• A_C_Pigeon ped release effect

• Optional pigeon item consumption on send

• Separate post office and pigeon delivery prices

• Separate post office and pigeon cooldowns

• Offline unread letter check when player joins

• Persistent “letter arrived” prompt until the letter is opened

• Incoming letter opens as a paper-only readable letter

• /adressbook command to show the player’s address code

• Address book command plays notebook/book animation

• oxmysql and ghmattimysql support

• Auto-create database tables option

• Fully configurable locations, prices, cooldowns, commands, and animations

Mail Flow

1. Go to a configured post office location.

2. Open the telegram interface from the native prompt.

3. Check your personal address code.

4. Share the address code with another player.

5. The other player saves you to their address book by using the code.

6. Send a letter from the post office.

7. Use the carrier_pigeon item to send a pigeon letter from the field.

8. Select a saved address book contact.

9. Write the letter content and send it.

10. The receiver gets a letter notification.

11. If the receiver is offline, the notification appears when they join.

12. The receiver opens the letter and reads it on a paper-only letter screen.

Address Book System

Players do not see a global player list.

Each character receives a private address code. Players must share this code through roleplay if they want to receive letters from each other.

Config.AddressCodePrefix = "BRB"

Config.AddressCodeLength = 6

The address book stores both owner and contact identity data:

owner_identifier

owner_charidentifier

contact_identifier

contact_charidentifier

VORP mode can resolve contacts through the characters SQL table. RSG mode stores active Player.PlayerData identity with license and citizenid.

Carrier Pigeon System

The carrier pigeon system uses a usable inventory item.

Config.PigeonItem = "carrier_pigeon"

Config.ConsumePigeonOnSend = true

Config.PigeonRequiresAddressBook = true

When the player sends a pigeon letter, the interface closes and the character performs a release animation while a pigeon ped flies away.

Config.PigeonRelease = {

Enabled = true,

PedModel = "A_C_Pigeon",

NativeFlyTask = true

}

Commands

Config.Commands = {

interact = "brb_mailbox_interact",

addressBook = "adressbook"

}

/adressbook shows the player’s address code as a notification and plays a notebook/book animation.

Requirements

VORP

ensure vorp_core

ensure vorp_inventory

ensure oxmysql

ensure brb-mailbox

RSG

ensure rsg-core

ensure rsg-inventory

ensure oxmysql

ensure brb-mailbox

Database

oxmysql

or

ghmattimysql

Database Tables

brb_mailbox_letters

brb_mailbox_contacts

brb_mailbox_addresses

The script can create these tables automatically if enabled:

Config.AutoCreateTables = true

Manual SQL is also included:

sql/brb_mailbox.sql

Configurable Options

Config.PostOfficeSendPrice = 5

Config.PigeonSendPrice = 0

Config.PigeonPurchasePrice = 12

Config.OfficeCooldownSeconds = 30

Config.PigeonCooldownSeconds = 90

Config.MaxContacts = 60

You can configure:

• Post office locations

• NPC model

• Blip name and blip hash

• Send prices

• Pigeon purchase price

• Cooldowns

• Address code prefix and length

• Pigeon item name

• Pigeon release animation

• Address book command

• Notification event

• Database driver