Overview & Installation

Complete overview of LuaBeans FiveM resources and integration.

What Are FiveM Resources?

LuaBeans provides two FiveM resources that integrate your server with the LuaBeans - Community Manager web panel:

1. LuaBeans Bridge (luabeans) - Core integration and API communication

2. LuaBeans Duty (luabeans_duty) - UI/menu layer for duty system

Quick Start

Minimum Setup

1. Copy both resources to your FiveM server

2. Add to server.cfg:

   set LUABEANS_API_BASE "https://hub.yourserver.com"
   set LUABEANS_LEO_API_TOKEN "your-api-token"
   ensure luabeans
   ensure luabeans_duty

3. Start server and test /duty command

Resources Work Together

• LuaBeans Bridge handles API communication and exports

• LuaBeans Duty provides user interface and menus

• Both are required for full functionality

Resource Overview

LuaBeans Bridge

Purpose: Core integration layer

What it does:

• Communicates with web panel API

• Manages player duty state

• Provides exports for other resources

• Caches player data

• Handles authentication

See: LuaBeans Bridge Documentation

LuaBeans Duty

Purpose: User interface for duty system

What it does:

• Provides /duty command

• Shows duty menu interface

• Manages vehicle spawning

• Handles uniform selection

• Manages loadout application

• Shows location markers

See: LuaBeans Duty Documentation

What You Can Do

With LuaBeans FiveM resources, you can:

• ✅ Duty System - Go on/off duty via commands

• ✅ Vehicle Spawning - Spawn department vehicles based on rank

• ✅ Uniform Management - Change into department uniforms

• ✅ Loadout System - Get department loadouts (weapons/items)

• ✅ Location Markers - View department locations and waypoints

• ✅ Rank-Based Access - Permissions based on rank in web panel

• ✅ Multiple Departments - Support for LEO, staff, and business departments

Requirements

Server Requirements

• FiveM server (latest recommended build)

• Internet access (for API communication)

• Discord identifiers for all players

Web Panel Requirements

• LuaBeans - Community Manager web panel running

• LEO_API_TOKEN configured in web panel .env

• Departments configured in web panel

• Users assigned to departments

Integration with Other Resources

ESX Integration

LuaBeans can sync duty state with ESX:

• Automatically sets player job when on duty

• Reverts to civilian job when off duty

• Respects permanent job assignments

rcore_police Integration

LuaBeans can bridge duty state with rcore_police:

• Automatically syncs duty status

• Keeps rcore_police in sync with LuaBeans

Custom Integrations

Use LuaBeans exports in your custom resources:

• Check duty status: exports['luabeans']:IsPlayerOnDuty()

• Get duty options: exports['luabeans']:GetDutyOptions()

• Update duty: exports['luabeans']:UpdatePlayerDuty(status)

Documentation Structure

Setup & Installation

• FiveM Configuration - Complete server setup guide

Resource Documentation

• LuaBeans Bridge - Core integration resource

• LuaBeans Duty - Duty system UI

API Reference

• FiveM API Documentation - Complete API reference

Support

For issues with FiveM resources:

• Check Configuration Guide for setup issues

• Review Bridge Documentation for API issues

• Check Duty Documentation for UI/menu issues

• See Troubleshooting for common problems