❓Installation Guide

The official installation guide for the BOII | Development FiveM Roleplay Framework.

Introduction

Welcome to the installation guide for the BOII | Development Roleplay Framework. This guide will walk you through the steps to set up the framework on your FiveM server and get you ready to create an immersive roleplay experience.

Prerequisites

Before you begin the installation process, make sure you have the following:

  • A working FiveM server environment.

  • Basic knowledge of server configuration and resource management.

Step 1: Setting Up a FiveM Server with TXAdmin

  1. TXAdmin Installation: If you're new to hosting FiveM servers, start by setting up your server using TXAdmin.

  2. Server Configuration: After installing TXAdmin, follow their instructions to configure your FiveM server settings.

  3. Deployment Type: When prompted to select a deployment type click on Popular Recipes and select CFX Default to install a default template. We will install the framework on top of this.

LogoSetting up a server using txAdminCfx.re Docs

Step 2: Downloading the Framework

  1. Download: Head to our official GitHub repository for the BOII | Development Roleplay Framework and click on the "Download" button to get the latest version.

https://github.com/boiidevelopment/boii_fivem_roleplay_frameworkgithub.com

Step 3: Installing the Framework

  1. Server Configuration: Open the provided server.cfg file and add your server, admins and database connection information. To change the server logo replace the provided server_logo.png with your own *(this must be 96x96)*. To change the connection and server banner replace the following links:

    To setup connection to your servers database enter your database information here:

  2. Resource Folder: Unzip the downloaded folder and locate the resource folder named [boii].

  3. Upload: Upload the [boii] folder to your FiveM server's resources directory.

  4. Resource Declaration: Open the provided server.cfg file and add your servers information

Step 4: Configuration

  1. Configuration Files: Navigate to the [boii] resource folder and locate the configuration files. These files allow you to tailor the framework to your server's needs.

  2. Edit Settings: Open the relevant configuration files contained within the resources (e.g., config.lua, etc.) using a text editor of your choice. Adjust the settings according to your roleplay theme and requirements.

Step 5: Starting the Framework

  1. Restart Server: Restart your FiveM server to apply the changes and start the BOII | Development Roleplay Framework.

Step 6: Testing and Further Setup

  1. Join Server: Connect to your FiveM server to ensure that the roleplay framework is functioning as expected.

  2. Testing: Create characters, explore the phone system, try out the inventory and job management, and interact with NPCs to verify that all core features are working correctly.

Troubleshooting

If you encounter any issues during the installation process, refer to our Troubleshooting Guide for solutions.

Join Our Community

For further assistance, connect with our community:

DEVELOPMENT DISCORD

BOII FIVEM ROLEPLAY SERVER DISCORD

Congratulations! You've successfully installed the BOII | Development Roleplay Framework on your FiveM server. Now, you're ready to craft immersive roleplay experiences.

Best regards,

The BOII | Development Team

PreviousRoleplay FrameworkNextResources

Last updated