DOCSEARCHbyAlgolia
Submit Docs

ESX Legacy Core Framework

website·Indexed 33 days ago

https://docs.esx-framework.org

A comprehensive framework for FiveM servers, featuring the es_extended main script for player management, data handling, and core systems. The documentation covers server-side and client-side functions, xPlayer objects, PlayerData, and various core components like esx_notify, esx_menu_default, and esx_skin, as well as a library of legacy addons for jobs, shops, and animations.

Tokens
42.7K
Snippets
287
Records
368
Agent score
64%

What's inside ESX

  1. Overview of esx_society

    esx_society provides society management for ESX, including employee management (hiring, firing, promoting/demoting, and salary changes), society bank accounts, and money washing.

    Critical Requirement: This script must be started before any other resources that utilize societies to ensure proper functionality.

  3. Overview of esx_taxijob

    The esx_taxijob resource for ESX Legacy allows players to operate a taxi service. Key features include picking up other players and charging them per mile, as well as completing life-like NPC missions to earn money.

  4. Overview of esx_ambulancejob features

    esx_ambulancejob is an EMS plugin for ESX Legacy that provides a death screen with early respawn and bleed-out timers, vehicle garages, and a revive menu for on-duty EMS personnel. Note: The death handling system is deprecated and will be replaced by a new system in es_extended in the future.

  5. Overview of esx_property features

    esx_property is a property system for ESX that enables players to buy, sell, and rent properties, and includes a built-in garage system. Key features include:

    • 95 premade properties with dynamic JSON storage
    • Key management, furniture systems, and furniture stores
    • Routing buckets for instancing and wardrobe functionality
    • Support for Shell/IPL, OX Inventory, and CCTV camera systems
    • Police raiding capabilities
    • Discord webhook support for logging
    • Integration with the Real Estate job

  6. Overview of esx_adminmenu features

    esx_adminmenu is a comprehensive administration tool for FiveM servers using ESX Legacy. It provides two primary user interfaces: a full NUI dashboard (default key F10) and a smaller keyboard-driven admin menu (default key F9). Key capabilities include player and vehicle management, ban management, server environment controls (weather, time, PvP), and a Svelte 5 powered dashboard for server and economy overviews.

  7. Overview of ESX Legacy Core Framework

    ESX Legacy Core is a comprehensive system providing the foundation for FiveM roleplay servers. It is designed with a modular architecture for scalability and customization, featuring secure client-server communication, MySQL/MariaDB database integration with player data caching, and a set of developer-friendly APIs for creating custom resources.

  8. Overview of esx_rpchat proximity chat

    The esx_rpchat resource adds proximity-based chat functionality to an ESX Legacy server, along with several specialized roleplay commands for in-character actions, out-of-character communication, and social media simulation.

  9. Overview of esx_addonaccount system

    The esx_addonaccount system is a special accounts framework used by scripts like esx_society and esx_billing to store money. It supports two types of accounts:

    • Shared accounts: Do not belong to a specific user (e.g., society accounts).
    • Non-shared accounts: Created for every user in the server and initialized in the database when a player loads (e.g., property accounts).

  11. Overview of esx_accessories

    The esx_accessories addon implements shops where players can purchase and manage accessories such as hats, helmets, glasses, masks, and ear accessories. These accessories can be toggled (put on or taken off) via a menu and are saved to the database. Note that this script only works with accessories purchased in the designated special areas of the clothing store, not those purchased via the standard esx_clotheshop script.