🏛️ BLN Society

📺 Preview

Video Preview

💰 Buy Now

Get it now

BLN Society is the management layer for every structured group on your server — a general store, saloon, ranch, sheriff's department, doctor's office, gang, or mayor's office. One resource tracks who belongs, what they can do, whether they are on duty, and where the money goes.

Whether you call it a business, a company, a faction, or a society, the setup is the same: members and ranks, permissions, finances, payroll, storage, fines, and a full audit trail — plus an API so your other scripts can plug in without reinventing any of it.

✨ What can you do with it?

For server owners

• 🏢 Unlimited societies — sheriffs, businesses, gangs, ranches, government offices, and more
• 👥 Members & ranks — hire, fire, promote, demote with a level-based hierarchy
• 🔐 Permission system — dot-namespaced permissions with wildcards and per-member overrides
• ⏱️ Duty tracking — clock in/out, worked hours, activity reports, inactivity sweeps
• 💰 Finances — multi-currency accounts, deposits, withdrawals, transfers, full ledger
• 💵 Payroll & paychecks — automatic wage runs, collect salary at the office
• 🏦 State-funded orgs — government departments that generate wages without a treasury
• 📦 Society storage — buy and manage shared inventories with rank gates
• ⚖️ Fines — issue and collect fines from members
• 📊 Action fees — configurable fees on hires, withdrawals, payroll runs, and more
• 📋 Audit logs — every action recorded, optional Discord webhook per society
• 🗺️ World points — blip, marker and prompt at the office (members only)
• 🛠️ Admin menu — create, move, edit and dissolve societies in-game
• 🌍 Translations — all player-facing text in one locale file, no rebuild needed

For developers

• 🔌 Export API — societies, members, ranks, money, duty, storage, fines
• 📦 Statebags — read membership, duty and balances on the client with no callbacks
• 📡 Events — react to member changes, balance updates, duty toggles
• 🪝 Hooks — veto hires, withdrawals, payroll and more before they commit
• 🔗 Integration-ready — EnsureSociety keyed to your resource so you never store society IDs

💻 Framework compatibility

✅ VORP ✅ RSG ✅ Custom

Framework access goes through bln_lib — this resource never talks to a framework directly.

📦 Dependencies

Start these before bln_society:

Resource	Why
bln_lib	Framework abstraction (VORP, RSG, and more)
bln_notify	Player notifications
oxmysql	Database access

⚙️ Installation

1. Download and extract bln_society into your resources folder
2. Add to your server.cfg after the dependencies:

ensure oxmysql
ensure bln_lib
ensure bln_notify
ensure bln_society

3. Start the server — no SQL file to import. Migrations run automatically on boot.
4. Restart and enjoy!

⚙️ Configuration

All setup lives in config/. Every option is commented in the files — open them and change what you need. No rebuild required.

File	What it's for
main.cfg.lua	Currencies, admin, hiring, duty, finance, payroll, fees, storage, fines, logs, UI, world points
presets.cfg.lua	Default rank ladders for new societies
permissions.cfg.lua	Permission list — add your own for custom scripts
blips.cfg.lua	Blip sprites for the admin picker
locale.cfg.lua	All player-facing text

First things most servers may touch:

1. Config.admin.allowIf — who can use /societyadmin
2. Config.currencies — cash-only vs cash + gold
3. Config.payroll — interval, mode, and paycheck rules

To disable a whole system (payroll, fines, storage, etc.), set its enabled = false in main.cfg.lua. Restart the resource after changes.

📋 Society presets

Presets are starter templates — they save you from building a rank ladder from scratch every time you create a society.

When you pick one (in /societyadmin or via the API), it pre-fills:

• Ranks — names, levels, salaries, and permissions (Owner → Manager → Employee, etc.)
• Funding — whether wages come from the society treasury or are state-generated

That is all they do at create time only.

You get the following presets ready for you by default:

Preset	Good for	Wages paid from
default	Any generic group	Society account
business	Shops, saloons, stores	Society account
law	Sheriff departments	State (no treasury needed)
government	Mayor's office, clerks	State
medical	Doctors, clinics	State
ranch	Ranches, farms	Society account
gang	Outlaw factions	Society account

Shipped presets live in config/presets.cfg.lua. Edit them, add your own, or pass custom ranks via the API.

🔐 Permissions

Every permission is registered in config/permissions.cfg.lua. The management menu renders from this list — add your own permissions here and check them from your resources.

Group	Examples
Society	society.manage, society.rename, society.delete, settings.manage
Members	members.hire, members.fire, members.promote, members.permissions, members.activity
Ranks	ranks.manage, ranks.salary
Finances	finances.view, finances.deposit, finances.withdraw, finances.transfer
Payroll	payroll.manage, payroll.view, payroll.collect
Duty	duty.use, duty.manage
Storage	storage.use, storage.deposit, storage.take, storage.buy, storage.manage
Fines	fines.view, fines.manage
Fees	tax.view
Logs	logs.view

Never check a rank name — check a permission instead. Deputy is a label players can rename; fines.manage is the contract.

Wildcards when granting: members.*, storage.*, or * for everything. Deny with a leading -, e.g. -finances.withdraw.

🌍 Translations

Every string the player reads lives in config/locale.cfg.lua. One file, no rebuild.

🎮 Using it in game

Players

Two ways into a society menu:

1. Stand at the society's point and press the prompt key (default E).
2. Another resource opens it via exports.bln_society:OpenSociety(societyId, source).

Duty is toggled from the menu header. At the point, members also get prompts for duty (default G) and collect salary (default R).

Optional: Config.paycheck.useCommand = 'collectsalary' to collect from anywhere.

Admins

/societyadmin opens the admin interface (if Config.admin.allowIf passes):

• Create — name, preset, owner, location with blip picker
• Manage — move points, edit societies, open menus, dissolve

Society menu

Tab	What it does
Overview	Summary, pending pay, quick stats
Members	Hire, fire, promote, permissions, activity
Ranks	Create and edit ranks, salaries, permissions
Finances	Balance, deposit, withdraw, transfer, ledger
Payroll	Run payroll, history, eligible members
Storage	Buy storages, set rank access, open inventory
Fines	Issue and manage member fines
Taxes	View action fees
Logs	Audit trail, Discord webhook in Settings
Settings	Society policies, inactivity, hiring rules

---

For developers

Each topic has its own page:

Page	Use when you need to…
Examples	Copy-paste patterns for common integrations
API Reference	Call exports, use the society handle, handle error codes
Statebags	Read synced client data (memberships, duty, balances)
Events	React after something changed
Hooks	Block an operation before it commits

Good to know

• One society per thing — tie yours to your resource with ownerResource + externalKey. You never need to store a society id; resolve it with SocietyByKey whenever you need it.
• Wait for ready — do not call mutating exports until bln_society:ready fires. Details: Events.
• Permissions, not rank names — check HasPermission('storage.use'), not "Deputy". Register custom permissions in config/permissions.cfg.lua.
• Who is acting — pass source when a player clicked something; omit it for system calls like booking revenue. Full rules: API — actor argument.
• Two kinds of money calls — AddMoney / RemoveMoney for revenue and costs (no permission check). Deposit / Withdraw for member actions (checks permissions, moves player money). Details: API Reference.
• Client reads are free — membership, duty, and balances sync to the client via statebags. No callback needed. Details: Statebags.
• Need a walkthrough? — see Examples.

---

❓ FAQ

🤝 Support

• 💬 discord.bln-studio.com
• 🛒 bln.tebex.io
• 📚 docs.bln-studio.com