Sandbox RP Framework

This is a heavily modified version of the Mythic Framework for Sandbox RP. It used to have a custom component-based system - but now its using a fully custom exports system written from the bottom up with major improvements to make the framework run better, with all UIs built in React. This codebase is released with full permissions from the original Mythic Framework authors, Alzar & Dr. Nick.

For questions, support, or community discussion, join my Discord server:

---

Dependencies

Ensure the following packages are installed:

Package	Download Link
Node.js	Download Here
MariaDB	Download Here (v12.0.2)
HeidiSQL	Download Here (can be installed via MariaDB)
Git for Windows	Download Here
Bun	Download Here

---

Prerequisites & Setup

1. Download the Source Code
   Clone or download the repository from GitHub.

2. Extract Files
   Extract the sandbox-fivem folder and open it.

3. Download FiveM Artifact
   Download the latest FiveM Windows Artifact: Download Here.

4. Set Up Artifact Folder

   • Create a new artifact folder in the root directory.
   • Move the downloaded artifact files into the artifact folder.

5. Configure Database

   • Update database.cfg with the correct HeidiSQL information.

6. Add CFX Key
   Add your cfx key to the sv_licenseKey field in the configuration.

---

Importing Database

1. Open HeidiSQL.
2. Import the database.sql file.

---

Launching the Server

1. First-Time Setup

   • Launch the server using ./artifact/FXServer.exe.
   • Follow the prompts to create a txAdmin username/password and link your FiveM account.

2. Project Setup

   • Link the project to an existing project.
   • Set the file paths for the .cfg files.

3. Enable OneSync

   • In txAdmin, enable OneSync for proper server functionality.
   • Restart the server.

4. Errors

   • If you encounter any errors after completing the setup steps:
     1. Restart the server.
     2. Verify all configurations and file paths.

---

Admin Permissions

1. Assign Roles
   Edit the ./config/permissions.cfg file to assign roles such as management, dev, admin, or operations.

2. Grant Global Admin
   To grant management permissions to all players, set danger_everyone_is_admin to 1 in ./config/core.ptr.cfg.
   Warning: This is highly discouraged for production environments as it poses significant security risks.

3. Access Admin Tools
   Use /admin or /staff to access the admin tool.

---

Logging

• Discord Logging
  Logging works only in production mode. To enable logs on a development server, set the environment to prod in core.ptr.cfg.

---

Support

If you enjoy this project and would like to support its continued development, any contribution is greatly appreciated! Your support helps keep this project alive and allows me to spend more time on it, as I've already invested countless hours into making this the best framework possible.