OBS-Paycheck - Lightweight pay system


Github - Obsidian Developments/obs-paycheck

obs-paycheck

A lightweight paycheck system for RedM servers using VORP.

obs-paycheck allows server owners to configure specific jobs that receive automatic paychecks at a configurable interval. This is a free version of the one available on our store front Obsidian County

Full version includes notifications and the ability to choose where the money is deposited into.


Requirements

Before installing obs-paycheck, make sure your server has:

  • RedM
  • VORP Core
  • vorp_inventory
  • oxmysql

The resource should be started after its required dependencies.


Recommended Resource Order

A typical setup should have the dependencies loaded before obs-paycheck:

cfg
ensure oxmysql
ensure vorp_core
ensure vorp_inventory

ensure obs-paycheck

Other VORP resources can be started according to your normal server configuration.


Important

obs-paycheck is intended to remain a configuration-driven system.

You should not need to edit the client or server Lua files simply to:

  • Add a job
  • Remove a job
  • Change a paycheck amount
  • Change the paycheck interval
  • Enable or disable debugging

These settings should be handled through:

config/config.lua


Quick Installation

For a quick installation:

  • Place obs-paycheck in your server’s resources directory.
  • Verify VORP Core, vorp_inventory, and oxmysql are installed.
  • Open config/config.lua.
  • Add the jobs that should receive paychecks.
  • Set the paycheck amounts.
  • Set the desired paycheck interval.
  • Add ensure obs-paycheck to server.cfg.
  • Restart the resource.
  • Test with Config.Debug = true.
  • Disable debug mode when finished.

Resource

Resource Name: obs-paycheck

Framework: VORP

Platform: RedM

Inventory: vorp_inventory

Database: oxmysql

Developer: Obsidian Developments/Obsidian County Roleplay

Code is accessible Yes
Subscription-based No
Lines (approximately) 250
Requirements vorpinventory, oxmysql
Support Yes
Assets are accessible Yes/No
Subscription-based Yes/No
Polygons (model and LOD) Number of polys
Texture size and amount Number
Requirements & dependencies Requirements
Support Yes/No