A fully featured and immersive pigeon letter system for RedM servers. Compatible with both VORP Core and RSG Core out of the box, with automatic framework detection. Players create a unique pigeon address, write letters, send them through an animated messenger bird, manage a personal archive, and stay in touch even when recipients are offline.

[SHOWCASE VIDEO]

Key Features

• Multi-Framework Support: Works natively with VORP Core and RSG Core. The resource auto-detects the active framework at startup. No manual reconfiguration needed when switching, just set Config.Framework = 'auto' and start the server.
• Complete Letter-Sending Flow: Players open their archive, write a letter with a custom sender name, subject, and body, choose a recipient by pigeon address, and optionally save a copy for their own records. A full in-game writing animation plays while composing.
• Animated Messenger Bird: When a letter is sent, a bird model spawns in front of the player, plays a sound effect, and flies off. The default model is a pigeon, with support for alternate job-based models — for example, players with the indio job send letters via a hawk instead.
• Personal Archive UI: A custom black and gold UI displays all received and sent letters. Unread letters are clearly flagged with a badge counter. Players can open any letter, view the full contents, and manage their history.
• Unique Pigeon Addresses: Each character registers a numeric pigeon address between 3 and 5 digits. Addresses are unique across the server and tied to the character, not the player account.
• Friends System: Players can save pigeon addresses with custom nicknames for quick access. The friends list shows up directly in the archive so they can write letters to known contacts in two clicks.
• Item Requirements: Sending a letter can require a cartaVacia item. Saving a copy consumes an extra item. Opening the archive can require an archivador usable item. All requirements are individually toggle-able from config.
• Cooldown System: A configurable cooldown prevents spamming. Default is 60 seconds between sends.
• Offline Discord Notifications: If a recipient is offline when a letter arrives, the resource can send them a Discord DM via a configured bot, telling them they have mail waiting. Works with both VORP and RSG player Discord ID storage schemas.
• Letter Limits: Configurable caps on total stored letters, title length, message length, and friend list size to keep the database clean.
• Sound Effects: Optional spatial sound effects for the pigeon and hawk animations using xsound. Volume and distance are configurable.
• Multi-Language: English and Spanish locale files included. Any language can be added by creating a new file in the locales folder.

Optimization

All database queries run through oxmysql asynchronously to avoid blocking the main thread. Player data is fetched server-side and sent to the NUI only when the archive is opened. The UI is a lightweight single-page HTML/JS application with no external CDN dependencies.

Requirements

Framework: vorp_core or rsg-core

Inventory: vorp_inventory or rsg-inventory

Library: ox_lib

Database: oxmysql

Optional:

• xsound (for letter and bird sound effects)
• Discord bot token (for offline notifications)

Installation

Place the ys_pigeonLetter folder in your resources directory.

Run schema.sql to create the required database tables, or simply start the resource and the tables will be created automatically.

Add the items from required_items_en.sql to your inventory config.

Add the resource to your server.cfg after your framework and inventory:

VORP:

• ensure ox_lib 
• ensure oxmysql
• ensure vorp_core
• ensure vorp_inventory
• ensure ys_pigeonLetter

RSG:

• ensure ox_lib
• ensure oxmysql
• ensure rsg-core
• ensure rsg-inventory
• ensure ys_pigeonLetter

Set your locale if needed:

setr ox:locale en