Features & Details
## ๐ Overview
**CY-Jobcreator** is a fully-featured, all-in-one job creation and management system for **RedM** servers running **VORP Core**. Create, configure, and manage unlimited custom jobs **entirely in-game** โ no code, no config editing, no restarts needed.
From a simple ranch to a full sheriff department with accounting, crafting, shops, and task boards โ everything is set up through a beautiful **Western-themed NUI** in minutes.
---
## ๐ผ๏ธ Preview
https://youtu.be/BwTrAx5jsGM
## โจ Features at a Glance
| Feature | Description |
|---------|-------------|
| ๐จ **Western UI** | Fully styled NUI with saloon-inspired design, Cinzel fonts, and parchment aesthetics |
| ๐ **Job CRUD** | Create, edit, duplicate, and delete jobs with a tabbed interface |
| ๐ **8 Position Types** | Boss, Storage, Duty, Cloakroom, Vehicle, Horse, Shop, Crafting, Task Board |
| ๐ **Unlimited Ranks** | Define as many ranks as you want, each with individual salary & permissions |
| ๐ฐ **Salary System** | Fixed interval or worktime-based, with conditions (on-duty, in-zone, not AFK) |
| ๐ฆ **Company Accounts** | Deposit, withdraw, salary-from-account, full transaction history |
| ๐ฆ **Job Storage** | Private or public stashes with per-rank withdraw/deposit permissions (VORP Inventory) |
| ๐จ **Crafting System** | In-game recipe manager, 30+ animations, grade restrictions, beautiful workbench UI |
| ๐ช **Shop System** | Employees stock items โ customers buy via NPC menu, dynamic pricing |
| ๐ **Task System** | Boss creates tasks โ employees accept & complete โ boss verifies & pays out |
| ๐ **Vehicles & Horses** | Per-job vehicle/horse lists, rank restrictions, auto-despawn on logout |
| ๐ **Cloakroom** | Saved outfit system for work uniforms |
| ๐ฅ **Boss Menu** | Hire/fire, promote/demote, salary management, accounting, storage & task management |
| ๐บ๏ธ **Blip System** | Automatic map markers with customizable sprites and colors |
| ๐ **Multilingual** | Full German & English localization out of the box |
| ๐ **Debug System** | Toggle debug prints per-module via config |
---
## ๐จ Crafting System
The crafting system comes with a **redesigned two-panel Workbench UI**:
-
๐ **Search bar** to filter recipes in real-time
-
๐ **Recipe sidebar** with cards showing result, craft time, and ingredient count
-
๐ **Detail panel** with ingredients list, result preview, and amount selector (+/โ)
-
โฑ๏ธ **Standalone progress bar** with cancel option
-
๐ญ **30+ crafting animations** (hammering, cooking, sawing, mining, farming, etc.)
-
๐ **Grade-locked recipes** โ restrict recipes to specific job ranks
-
โ๏ธ **In-game Recipe Manager** โ create, edit, and delete recipes without touching any files
---
## ๐ช Shop System
- Employees can place items from their inventory into a **shop display** with custom pricing
- Customers interact with the shop point and browse available items via VORP menu
- Dynamic pricing โ each employee sets their own price per item
- Sales revenue goes to the **company account** (if enabled)
- Full buy/sell flow with quantity selection
---
## ๐ Task System
-
**Boss creates tasks** via in-game popup (title, description, required item, reward)
-
**Employees browse** the task board and accept available tasks
-
**Mark as complete** when done โ task goes to boss for **verification**
-
**Boss verifies** and reward is paid out automatically
- Tasks can require specific items and amounts
---
## ๐ฅ Boss Menu & Society System
The boss menu and duty toggle are combined into a **single interaction point**:
-
Press **G** โ Opens Boss Menu (manage employees, salary, accounting, storage, tasks)
-
Press **F** โ Toggle Duty (clock in/out)
-
Boss menu modules are **individually toggleable** per job
-
Only players at or above the configured **boss rank** can see the boss option
---
## ๐ฐ Salary & Accounting
- **Fixed interval** or **worktime-based** payment
- Configurable conditions: only when on-duty, only in work zone, not when AFK
- **Company account** with deposit/withdraw and full transaction history
- Salary can be paid from the company account (realistic economy)
- Boss can manage salary rates per rank in-game
---
## ๐ฆ Storage System
-
Integrates with **VORP Inventory** custom inventories
-
**Private** (employees only) or **Public** (shop display) modes
- Configurable storage size (in kg)
- **Per-rank permissions** for withdraw and deposit
- Auto-registers with VORP Inventory on job creation โ no manual setup needed
---
## ๐ Vehicles & Horses
-
Define available vehicles and horses **per job** with labels
-
**Rank restrictions** โ lock certain vehicles to higher ranks
-
Automatic **despawn on logout/disconnect**
- Spawn/store via interaction point with VORP menu
---
## ๐ Interaction Points
Set up to **8 different interaction points** per job, all configurable in-game:
| Point | Function |
|-------|----------|
| ๐ข Boss Menu | Society management (combined with duty toggle) |
| ๐ฆ Storage | Open job stash |
| ๐ Cloakroom | Change into work outfit |
| ๐ Vehicle Spawn | Spawn/store job vehicles |
| ๐ Horse Spawn | Spawn/store job horses |
| ๐ช Shop | Employee shop display |
| ๐จ Crafting | Open workbench with recipe list |
| ๐ Task Board | Browse and accept tasks |
---
## ๐ ๏ธ Modules
Every feature is a **toggleable module** that can be enabled/disabled per job:
```
โ Storage ย ย ย ย ย โ Salary System ย ย โ Applications
โ Work Time ย ย ย ย โ Tasks ย ย ย ย ย ย โ Vehicles
โ Horses ย ย ย ย ย โ Shop ย ย ย ย ย ย ย โ Crafting
โ Cloakroom ย ย ย ย โ Company Banking
```
---
## ๐ฎ Commands
| Command | Description |
|---------|-------------|
| `/jobcreator` | Opens the Job Creator admin UI |
| `/setjob [playerID] [jobID] [grade]` | Sets a player's job and grade |
| `/recipemanager [jobID]` | Opens the recipe manager for a job |
| `/joblist` | Lists all registered jobs |
| `/jobinfo [jobID]` | Shows detailed info about a job |
| `/editjob [jobID]` | Opens the UI to edit a specific job |
---
## ๐ Dependencies
| Resource | Required |
|----------|----------|
| [vorp_core](https://github.com/VORPCORE/vorp-core-lua) | โ Yes |
| [vorp_inventory](https://github.com/VORPCORE/vorp_inventory-lua) | โ Yes |
| [vorp_menu](https://github.com/VORPCORE/vorp_menu) | โ Yes |
| [oxmysql](https://github.com/overextended/oxmysql) | โ Yes |
---
## โ๏ธ Configuration
Everything is configured via `config.lua`:
```lua
Config.Debug = false ย ย ย ย ย ย ย ย ย ย -- Toggle debug prints
Config.AdminGroups = { "admin", "superadmin", "owner" }
Config.Language = 'en' ย ย ย ย ย ย ย ย ย -- 'de' or 'en'
Config.InteractionDistance = 2.5 ย ย ย ย -- Prompt interaction range
Config.MarkerDistance = 10.0 ย ย ย ย ย ย -- Blip visibility range
Config.DefaultMaxEmployees = 10
Config.DefaultSalaryInterval = 30 ย ย ย -- minutes
Config.DefaultStorageSize = 100 ย ย ย ย -- kg
```
All UI labels, notifications, prompts, and menu texts are fully localizable in the locale tables.
---
## ๐พ Database
The resource uses the following tables (auto-created):
| Table | Purpose |
|-------|---------|
| `job_registry` | Stores all job configurations as JSON |
| `job_shop_items` | Shop display items placed by employees |
| `job_accounts` | Company account balances |
| `job_transactions` | Full transaction history |
| `job_recipes` | Crafting recipes per job |
| `job_tasks` | Task board entries |
| `job_duty_log` | Duty clock-in/out history |
Compatible with **MySQL** and **MariaDB**.
---