CAS VORP Inventory - Setup Guide

CAS Admin Panel — Installation Guide

Advanced Admin Panel for RedM Servers — Supports VORP and RSGCore frameworks.

---

Requirements

Before installing CAS Admin Panel, make sure your server meets the following requirements:

Requirement	Details
RedM Server	Any recent build of RedM (txAdmin recommended)
Framework	VORP Core + VORP Inventory OR RSGCore + RSG Inventory
Database	MySQL / MariaDB with oxmysql resource installed and running
Discord Bot	A Discord bot token with guild member access (for avatar and user data)
Node.js	v16+ (only if you need to rebuild the UI — pre-built UI is included)

Optional

Optional	Details
Steam API Key	For Steam avatar fallback when Discord avatar is unavailable. Get one at steamcommunity.com/dev/apikey
Discord Webhooks	For logging admin actions, bans, economy changes, etc. to Discord channels

---

Step 1 — Download & Place the Resource

1. Download and extract the cas-admin-panel folder.

2. Place it inside your server's resources directory. We recommend creating a [CAS] folder for organization:

resources/
  [CAS]/
    cas-admin-panel/
      client/
      server/
      shared/
      config/
      locales/
      web-dist/
      fxmanifest.lua
      yellowsql.sql
      ...

---

Step 2 — Import the Database

Import the included yellowsql.sql file into your MySQL/MariaDB database. This creates all required tables:

Using phpMyAdmin

1. Open phpMyAdmin and select your server's database.

2. Go to the Import tab.

3. Choose yellowsql.sql from the cas-admin-panel folder.

4. Click Go.

Using MySQL CLI

mysql -u root -p your_database_name < yellowsql.sql

Tables Created

Table	Purpose
admin_data	Admin roles and permissions
admin_logs	All admin action logs
admin_chat_messages	Admin-to-admin chat history
bans	Ban records (VORP framework)
cas_bans	Ban records (RSGCore framework — avoids conflict with RSGCore's own bans table)
player_warnings	Player warning records
player_reports	Player-submitted reports
report_messages	Report conversation messages
player_leaderboard	Playtime, money, and stats tracking
player_avatar_cache	Cached Discord/Steam avatars for offline display
whitelist_data	Whitelist entries
custom_teleport_locations	Saved teleport locations
server_daily_metrics	Daily server statistics
permission_cooldowns	Action cooldown tracking
permission_logs	Permission usage logs

Note: If you are using RSGCore, the system automatically uses cas_bans instead of bans to avoid conflicts. No manual action needed.

---

Step 3 — Configure the Resource

All configuration files are in the config/ folder. The main file is config/main.lua.

3.1 — Default Owner (Required)

Set your identifier so you are automatically assigned the Owner role on server start:

Config.DefaultOwners = {
    "steam:YOUR_STEAM_HEX_HERE",   -- VORP uses steam hex
    -- "license:YOUR_LICENSE_HERE", -- RSGCore uses license
}

• VORP: Use your Steam hex identifier (e.g., steam:110000xxxxxxxxx)

• RSGCore: Use your license identifier (e.g., license:xxxxxxxxxxxxxxx)

• You can add multiple identifiers — the system matches whichever the framework uses.

How to find your identifier: Check your server console when you connect — it prints all player identifiers.

3.2 — Discord Bot (Required)

Config.Discord = {
    enabled = true,
    botToken = "YOUR_DISCORD_BOT_TOKEN",
    guildId = "YOUR_DISCORD_SERVER_ID",
    apiUrl = "https://discord.com/api/v10"
}

Creating a Discord bot:

1. Go to discord.com/developers/applications

2. Click New Application → name it → go to the Bot tab

3. Click Reset Token → copy the token → paste into botToken

4. Enable Server Members Intent under Privileged Gateway Intents

5. Invite the bot to your Discord server using the OAuth2 > URL Generator (select bot scope)

6. Copy your Discord server ID → paste into guildId

Important: The bot must be in your Discord server and have the Server Members Intent enabled, otherwise avatars and usernames will not load.

3.3 — Steam API Key (Optional)

Config.Steam = {
    enabled = true,
    apiKey = "", -- Leave empty to skip Steam avatar fallback
}

If a player doesn't have a Discord avatar, the system falls back to their Steam profile picture. Leave apiKey empty to skip this — players without Discord avatars will get a default avatar instead.

3.4 — General Settings

Config.UseWhitelist = false       -- Enable/disable whitelist system
Config.DebugMode = false          -- Set to true for troubleshooting (prints debug info to console)
Config.DefaultLanguage = "en"     -- "en" for English, "tr" for Turkish
Config.Key = 0x3C3DD371           -- PAGEDOWN key to open the panel in-game

Config.PlayersPage = {
    PlayersPerPage = 25,          -- Players shown per page in the player list
}

Available languages: en (English), tr (Turkish). Language files are in locales/.

3.5 — Discord Webhooks (Optional)

Edit config/webhooks.lua to receive admin action logs in Discord channels:

Config.Discord.Webhooks = {
    player_action = "https://discord.com/api/webhooks/...",
    admin_action  = "https://discord.com/api/webhooks/...",
    server_event  = "https://discord.com/api/webhooks/...",
    security      = "https://discord.com/api/webhooks/...",
    economy       = "https://discord.com/api/webhooks/...",
    system        = "https://discord.com/api/webhooks/...",
}

Leave any webhook URL empty ("") to disable that category.

---

Step 4 — Ensure & Start the Resource

Add the resource to your server.cfg:

ensure oxmysql
ensure vorp_core        # or rsg-core
ensure vorp_inventory   # or rsg-inventory
ensure cas-admin-panel

Important: cas-admin-panel must start after oxmysql and your framework. The framework (VORP or RSGCore) is auto-detected — no configuration needed.

If your resource is inside a [CAS] folder, you may need:

ensure [CAS]

or ensure it individually by its folder name.

---

Step 5 — First Launch Verification

1. Start your server.

2. Connect to the server.

3. Press Page Down (default key) or type /adminpanel in chat to open the panel.

4. You should be logged in as Owner automatically (if your identifier is in Config.DefaultOwners).

5. Check the server console for any error messages.

Troubleshooting First Launch

Problem	Solution
Panel doesn't open	Check that cas-admin-panel is running: type ensure cas-admin-panel in server console
"No permission" error	Verify your identifier in Config.DefaultOwners matches what the server shows
No avatars loading	Ensure the Discord bot token is valid and the bot has Server Members Intent enabled
Database errors	Make sure oxmysql is running and yellowsql.sql was imported into the correct database
Framework not detected	Ensure your framework (vorp_core or rsg-core) is started before cas-admin-panel

---

Configuration Reference

Admin Roles

CAS Admin Panel uses a role-based hierarchy with 5 levels. Higher-level admins can manage those below them.

Role	Level	Description
Helper	1	Basic moderation — customizable permissions
Moderator	2	Full permissions
Admin	3	Full permissions
Head Admin	4	Full permissions
Owner	5	Full permissions — can manage all roles

Role permissions are configured in config/permissionconfig.lua. The Helper role has individual permissions listed — you can add or remove specific permissions. Moderator and above have wildcard ("*") access by default.

Commands

All commands are configured in config/commands.lua. You can:

• Rename any command by changing the command field

• Add aliases by adding strings to the aliases table

• Disable any command by setting enabled = false

• Change permissions by editing the permission field

Default Commands

Command	Aliases	Description	Category
/adminpanel	/admin, /ap	Open the admin panel	General
/report	/rep	Submit a report (all players)	General
/myreports	/reports	View your reports (all players)	General
/revive	/rev	Revive a player	Player
/heal	—	Heal a player	Player
/kill	—	Kill a player	Player
/freeze	/fr	Toggle freeze on a player	Player
/goto	/tp	Teleport to a player	Player
/bring	/summon	Bring a player to you	Player
/spectate	/spec	Spectate a player	Player
/respawn	—	Respawn a player	Player
/kick	—	Kick a player	Moderation
/ban	—	Ban a player	Moderation
/warn	—	Warn a player	Moderation
/clearweapons	/cw	Clear player's weapons	Moderation
/clearitems	/ci	Clear player's items	Moderation
/clearinv	/wipe	Clear entire inventory	Moderation
/fire	/burn	Set player on fire	Troll
/lightning	/strike	Strike with lightning	Troll
/heaven	/sky	Teleport to sky	Troll
/ragdoll	/rag	Ragdoll a player	Troll
/wildattack	/animal	Send animal attack	Troll
/drainstamina	/drain	Drain stamina	Troll
/handcuff	/cuff	Handcuff a player	Troll
/drunk	/high	Make player drunk	Troll
/invisible	/invis	Toggle visibility	Troll

Navigation

The sidebar navigation order can be customized in config/navigation.lua. Add, remove, or reorder entries:

Config.Navigation = {
    { key = "dashboard", name = "Dashboard" },
    { key = "players", name = "Players" },
    { key = "whitelist", name = "Whitelist" },
    -- ... add or reorder as needed
}

Keybind

The default key to open the panel is Page Down (0x3C3DD371). Change it in config/main.lua:

Config.Key = 0x3C3DD371 -- Change to your preferred key hash

Refer to the FiveM/RedM key hash list for available keys.

---

Panel Sections Overview

Section	Description
Dashboard	Server overview with online players, economy, uptime, and a Top Players leaderboard
Statistics	Player activity, economy trends, and live performance monitoring with auto-refresh
Players (Online)	Full player management — profile, actions, economy, inventory, bans, warnings, troll actions
Players (Offline)	Manage offline players through the database — inventory, economy, bans, character edits
Admins	Role-based admin management with rank hierarchy
Whitelist	Server access control with status tracking
Reports	Player report management with claim, respond, and resolve workflow
Logs	Searchable admin action log with 6 categories
Admin Chat	Real-time admin-to-admin messaging
Live Map	RDR2 world map with player markers, avatars, and quick actions
Teleports	Saved locations with categories and custom coordinate entry
Blips	Custom map marker creation with icon picker
Spawner	Entity spawner for wagons, horses, props, and peds
Coords	Live coordinate display with one-click copy in multiple formats
Server Settings	Time, weather, timescale, wind control, and server actions (restart, announce)
Resources	Resource monitoring with start, stop, restart, and real-time status
Self Menu	Keyboard-driven quick menu — god mode, noclip, invisibility, spawning, and more

---

Adding New Admins

There are two ways to add admins:

Method 1 — In-Game (Recommended)

1. Open the admin panel → go to Admins section.

2. Click Add Admin.

3. Enter the player's Steam Hex (e.g., steam:110000xxxxxxxxx).

4. Select a role.

5. Click Add.

Method 2 — Database

Insert directly into the admin_data table:

INSERT INTO admin_data (identifier, username, `group`)
VALUES ('steam:110000xxxxxxxxx', 'PlayerName', 'admin');

Valid roles: helper, moderator, admin, headadmin, owner

---

Updating the Resource

1. Back up your config/ folder.

2. Replace all files with the new version.

3. Restore your config/ folder (configs are in escrow_ignore, so they are never encrypted).

4. Check the changelog for any new SQL tables — run them if needed.

5. Restart the resource: ensure cas-admin-panel

Your config files are safe. The escrow_ignore list in fxmanifest.lua ensures that config/*.lua, locales/*.lua, and select server files are never encrypted and always editable.

---

FAQ

Q: Does this work with both VORP and RSGCore? A: Yes. The framework is auto-detected on startup. No configuration needed.

Q: Can I use this without a Discord bot? A: Set Config.Discord.enabled = false. The panel will work but player avatars and Discord usernames will not be available.

Q: Can I use this without the whitelist? A: Yes. Set Config.UseWhitelist = false in config/main.lua. The whitelist section will still be visible but non-functional unless enabled.

Q: How do I change the language? A: Set Config.DefaultLanguage = "tr" for Turkish or "en" for English in config/main.lua. You can also create custom language files in the locales/ folder.

Q: I'm getting "oxmysql not found" errors. A: Make sure oxmysql is installed and started before cas-admin-panel in your server.cfg.

Q: Players can open the admin panel? A: No. Only players with an entry in the admin_data table (or listed in Config.DefaultOwners) can access the panel. Regular players will see nothing when pressing the keybind.

Q: Can I customize which permissions each role has? A: Yes. Edit config/permissionconfig.lua. The Helper role has individual permissions listed — add or remove as needed. Moderator+ roles have wildcard "*" by default, but you can replace that with specific permissions.

---

Support

If you encounter issues or need help, contact CAS Development through your purchase platform.