ULTIMATE DOCUMENTS SYSTEM

# synz_documents

**The complete document management system for FiveM roleplay servers.**

Replace `/me holds badge` and `/me hands paper` with real, persistent,

signable, verifiable documents that live in the database and travel

through the inventory. Built for serious RP communities.

---

## ✨ Features

### 25 default templates included

Police, Sheriff, EMS, Lawyer, Mechanic, Car Dealer, Real Estate,

Government, Public — fully editable through the in-game admin UI

without restarts.

### Visual template editor

Build custom documents with no code. Drag-and-drop fields, choose

from 15 official seals, set accent colors, fonts, watermarks and

layouts.

### 14 server-resolved auto-fields

Player name, DOB, job, gender, phone, plate, server time and more —

filled automatically and **impossible to spoof** from the client.

### Digital signatures

Mouse-drawn canvas signatures or name-mode. Up to 8 signature slots

per template with roles: signer, witness, notary, official. The

notary flow lets nearby players sign during a Show action.

### QR verification

Every document gets a unique 8-character verification code rendered

as a QR on the paper. `/scanqr` opens a fullscreen scanner that reads

the QR off a nearby player's document — proximity-validated.

### Document lifecycle

Create, sign, copy, send, show, expire, revoke. Optional banking

fees per action. Send transfers ownership at the database level;

Show displays a read-only overlay to nearby players for 8 seconds.

### Custom categories

Admins can create custom document categories at runtime — name,

icon, accent color. Perfect for departments your server has that

aren't covered by the defaults.

### Inventory integration

Documents live as a metadata item in the player's inventory. Using

the item opens the document. Giving the item physically transfers

ownership in the database (on inventories that propagate metadata).

### Per-document audience

Restrict who can read a document with `allowed_players` and

`allowed_jobs` lists. Court documents visible to multiple parties,

internal department forms locked to specific ranks, etc.

### Tablet animation

While the UI is open, the player visibly holds a tablet prop and

plays a tapping idle. Other players see why the player is standing

still. Auto-skips in vehicles, swimming, ragdolled, dead.

### Discord webhooks

Per-event embeds for create / sign / revoke / expire. Per-template

webhook overrides — route court documents to `#court`, police

documents to `#police`.

---

## 🔌 Compatibility

**Frameworks:** ESX (legacy + new), QBCore, QBox, standalone

**Multi-character:** qs-multicharacter, esx_multicharacter, qb-multicharacter

**Inventories:** ox_inventory, qs-inventory, qb-inventory, ps-inventory,

lj-inventory, codem-inventory, origen_inventory, tgiann-inventory,

core_inventory, ESX legacy + custom adapter hook

**Banking:** okokBanking, qb-banking, Renewed-Banking, esx_addonaccount,

pickle_banking, framework cash fallback

**Phones:** lb-phone, qs-smartphone, qs-smartphone-pro, gksphone,

yseries, roadphone, okokPhone

**Garages:** qb-garages, qs-advancedgarages, cd_garage, jg-advancedgarages,

loaf_garage, okokGarage, ESX native + generic SQL fallback

**Appearance:** illenium-appearance, fivem-appearance, qb-clothing,

esx_skin, tgiann-clothing

**Dispatch:** cd_dispatch, ps-dispatch, qs-dispatch, origen_police,

linden_outlawalert + custom adapter

**Everything autodetects on resource start.** No manual configuration

required for any of the above — the script picks up your environment

on boot.

---

## 🌍 19 languages included

bg, cs, da, de, el, **en**, **es**, fi, **fr**, hu, **it**, nl, no, pl,

pt, ro, ru, sv, tr — out of the box.

---

## 📋 Installation

1. Drop into `resources/`

2. `ensure synz_documents` in `server.cfg`

3. SQL auto-installs on first start

4. Done.

No manual SQL imports. No complex setup. The 25 templates are seeded

automatically on first boot.

---

## 🛠 Exports

Six exports for integration with your other resources:

```lua

exports.synz_documents:CreateDocument(playerId, data)

exports.synz_documents:GiveDocument(playerId, templateId, overrides)

exports.synz_documents:GetDocuments(playerId)

exports.synz_documents:OpenUI(playerId, mode)

exports.synz_documents:DispatchAlert(playerId, data)

exports.synz_documents:IsAdmin(playerId)

```

Use `CreateDocument` to issue automated tax bills, court summons,

parking tickets from your existing scripts. Use `IsAdmin` to share

the same admin definition across resources.

---

## ⌨ Commands

| Command | Who | What |

|---|---|---|

| `/documents` | Everyone | Open the documents UI (default key: L) |

| `/docadmin` | Admins | Open the admin panel |

| `/scanqr` | Configurable | Open the QR scanner |

| `/docprivacy` | Admins | Audit template privacy state |

| `/docwhoami` | Everyone | Diagnose admin recognition |

---

## 📦 What you get

- ✅ Encrypted resource (escrow protected)

- ✅ All 25 default templates

- ✅ All 19 language files

- ✅ Full configuration file with inline comments

- ✅ Item snippets for every supported inventory

- ✅ SQL install script (auto-runs on first start)

- ✅ Complete documentation

- ✅ Discord support

---

## 🔗 Links

📖 **Documentation:** https://synzlabs.com/docs/ultimate-documents-system

🎬 **Showcase video:** https://youtu.be/KwMjQpUK8BI

💬 **Discord:** https://discord.com/invite/synzlabs

---

## ⚖ License

Encrypted via Tebex Escrow. Single-server license per purchase.

For multi-server licensing or open-source variant, contact us

on Discord.

---

## ❓ FAQ

**Does this work with my framework?**

ESX (any version), QBCore, QBox and standalone are all supported and

autodetected. If you're on a custom fork, the standalone fallback

still gives you the full feature set minus framework-specific data

(jobs, identifiers).

**Will I need to write code to add my own document types?**

No. The visual template editor (`/docadmin`) covers everything —

fields, layout, design, content, signatures, expiration. You only

touch code if you want to add a brand new auto-field type.

**Does it conflict with existing document scripts?**

No. The resource is fully namespaced (`synz_documents.*` tables,

`document` item — renameable). You can run it alongside existing

scripts during migration.

**Is there a refund policy?**

Per Tebex's standard escrow rules — no refunds on encrypted resources

once delivered. Try the showcase video first to confirm the feature

set matches your needs.

**Can I get the source code?**

Yes — the open-source variant is available. Contact on Discord for

pricing.