Skip to content
Hexa Development

HEXA FRAMEWORK

A modern RedM framework for building roleplay servers.

Fast. Modular. Developer-friendly.


Documentation RedM Lua GitHub


Framework · Bridge · APIs · Developer Tools


About Hexa

Hexa Framework is a modular framework designed for building modern RedM roleplay servers.

The project focuses on providing a clean foundation for server development without forcing every system into a single massive resource.

hexa_core provides the essential server infrastructure, while additional Hexa resources can be added, removed, or replaced independently.

Core principles

  • Modular — use only the systems your server needs
  • Developer-friendly — predictable APIs and project structure
  • Performance-focused — avoid unnecessary client and server overhead
  • Extensible — build custom resources directly on top of Hexa
  • Interoperable — compatibility layers for existing RedM resources
  • Documented — APIs and installation guides maintained alongside the framework

Projects

Every part of Hexa is its own repository. Install only what your server needs.

Framework

Project Description
hexa_core Core framework — players, jobs, items, economy, status, callbacks, permissions, and persistent character data
hexa-bridge Compatibility layer for running supported RSG and VORP resources on Hexa

Resources

Project Description
hexa_inventory Persistent grid inventory — stashes, shops, ground drops, secure trading, quick slots
hexa_progbar Screen-fixed progress bar — standalone drop-in for ox_lib progressBar

Documentation & Tooling

Project Description
hexa-docs Official documentation and API reference, powered by VitePress
txAdmin One-click txAdmin recipe that deploys the whole Hexa stack
rdr2-unpack Read a local RDR2 install into open formats — GLB models, PNG textures, parsed .ymap placements

hexa_core

hexa_core is the foundation of the Hexa ecosystem.

It handles shared functionality that other resources can access through a consistent API.

Included systems

Player Management
├── Player lifecycle
├── Character data
├── Metadata
└── Player state

Economy
├── Cash
├── Bank
└── Money transactions

Jobs
├── Job data
├── Grades
└── Job state

Inventory Integration
├── Items
├── Item metadata
└── Item operations

Server APIs
├── Callbacks
├── Events
├── Exports
└── Shared functions

Administration
├── Permissions
├── Groups
└── Command access

Quick Start

Get the Hexa core object from your resource:

local HexaCore = exports['hexa_core']:GetCoreObject()

Access a player:

local Player = HexaCore.Functions.GetPlayer(source)

if not Player then
    return
end

Add money:

Player.Functions.AddMoney(
    'cash',
    100,
    'welcome_bonus'
)

From here, your resource can interact with Hexa through the core API without duplicating player, economy, permission, or callback logic.


Example Resource

local HexaCore = exports['hexa_core']:GetCoreObject()

RegisterNetEvent('example:server:reward', function()
    local src = source

    local Player = HexaCore.Functions.GetPlayer(src)

    if not Player then
        return
    end

    Player.Functions.AddMoney(
        'cash',
        100,
        'example_reward'
    )
end)

Bridge

Already have resources built for another RedM ecosystem?

hexa-bridge is designed to reduce migration work by providing compatibility APIs for supported resources.

Existing Resource
       │
       ▼
┌─────────────────┐
│   hexa-bridge   │
└────────┬────────┘
         │
         ▼
┌─────────────────┐
│    hexa_core    │
└─────────────────┘

The goal is simple:

Migrate your server progressively instead of rewriting everything at once.

Compatibility depends on the APIs used by each resource. Check the documentation for currently supported bridge functionality.


Architecture

Hexa follows a modular architecture where hexa_core acts as the shared foundation.

                    ┌──────────────────┐
                    │    hexa_core     │
                    └────────┬─────────┘
                             │
          ┌──────────────────┼──────────────────┐
          │                  │                  │
          ▼                  ▼                  ▼
   ┌────────────┐     ┌────────────┐     ┌────────────┐
   │ Hexa Script │     │ Hexa Script │     │ Hexa Script │
   └────────────┘     └────────────┘     └────────────┘
          │
          ▼
   ┌─────────────┐
   │ hexa-bridge │
   └──────┬──────┘
          │
          ▼
   Existing RedM Resources

This keeps individual systems independent while sharing a common foundation.


Tech Stack

Technology Usage
Lua 5.4 RedM / FXServer resources
FXServer Server runtime
MariaDB / MySQL Persistent server data
oxmysql Database communication
VitePress Documentation
Vue.js Documentation frontend

Documentation

Complete installation instructions, API references, examples, and development guides are available in the official documentation.

Documentation includes:

  • Installation
  • Configuration
  • Core API
  • Player API
  • Money API
  • Jobs
  • Items
  • Callbacks
  • Permissions
  • Events
  • Exports
  • Bridge compatibility
  • Resource development examples

Repository Structure

A typical Hexa-based server can be organized like this:

resources/
│
├── [hexa]/
│   ├── hexa_core/
│   ├── hexa_inventory/
│   ├── hexa_progbar/
│   ├── hexa-bridge/
│   └── ...
│
├── [standalone]/
│   └── ...
│
└── [maps]/
    └── ...

Each system remains its own resource instead of turning the core into a monolith.


Building with Hexa

A Hexa resource should communicate with the framework through documented APIs rather than directly accessing internal framework data.

local HexaCore = exports['hexa_core']:GetCoreObject()

This provides a stable entry point for:

HexaCore
├── Functions
├── Shared
├── Commands
├── Callbacks
└── Player APIs

Keeping resources behind public APIs makes them easier to maintain, update, and reuse.


Development Status

Hexa Framework is under active development.

APIs, bridge compatibility, tooling, and documentation will continue to expand as the ecosystem grows.

For production servers, review release notes before updating core resources.


Build the world. Define the rules.

Powered by Hexa Framework


Documentation · เอกสารภาษาไทย · hexa_core · hexa_inventory · hexa_progbar · hexa-bridge · Organization


Ride horses. Write code.

Pinned Loading

  1. txAdmin txAdmin Public

    txAdmin recipe for deploying a Hexa Framework RedM server — hexa_core, hexa_inventory, hexa_progbar and oxmysql in one deployment

Repositories

Showing 8 of 8 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…