Download & Installation

On this page we'll be guiding you through the installation of the Mercy Framework. On the previous page we guided you through installing a MySQL server for the framework. Make sure you have done all necessary steps for that before you continue!

Download & Installation

Since you have setup the database already we hope you already downloaded the framework and put it somewhere on your system! If not please look at the following steps.

Clone using Git (Fastest)

In the following steps we'll be guiding you on how to clone the Mercy Framework so it'll end up on your system in no time!

1. Download Git if you have not already.
2. Setup Git using your Github Account.
3. Type following command in the folder where you would like the framework to be downloaded in:

git clone https://github.com/Mercy-Collective/mercy-framework.git

4. Make sure to have the following folder structure:

mercy-framework/
├─ artifacts/ (FiveM Artifacts)
├─ server-data/ (Github Repository Files)
│  ├─ Mercy-CasinoWheelUI/
│  ├─ Mercy-VoiceServer/
│  ├─ cfg/
│  ├─ resources/
│  ├─ .gitignore
│  ├─ LICENSE
│  ├─ README.md
│  ├─ [Starter].bat
│  ├─ frameworkdb.sql
│  ├─ logo.png

5. Make sure to go into the cfg folder and setup every .cfg file correctly!
6. If you are ready to start the server, make sure to change the file path in the "[Starter].bat". For example:

Path with spacing (Add ")

"C:\Users\Firstname Lastname\Desktop\mercy-framework\artifacts\FXServer.exe"

Path without spacing

C:\Users\Administrator\Desktop\mercy-framework\artifacts\FXServer.exe

ZIP (Time Consuming)

In the following steps we'll be guiding you on how to download the Mercy Framework using the Download ZIP button on the Github repository page.

1. Click on the green "Code" button on the top right of the repository page.
2. Click on "Download ZIP"
3. Once the download is complete extract the framework into a folder.
4. Make sure to have the following folder structure:

mercy-framework/
├─ artifacts/ (FiveM Artifacts)
├─ server-data/ (Github Repository Files)
│  ├─ Mercy-CasinoWheelUI/
│  ├─ Mercy-VoiceServer/
│  ├─ cfg/
│  ├─ resources/
│  ├─ .gitignore
│  ├─ LICENSE
│  ├─ README.md
│  ├─ [Starter].bat
│  ├─ frameworkdb.sql
│  ├─ logo.png

5. Make sure to go into the cfg folder and setup every .cfg file correctly!
6. If you are ready to start the server, make sure to change the file path in the "[Starter].bat". For example:

Path with spacing (Add ")

"C:\Users\Firstname Lastname\Desktop\mercy-framework\artifacts\FXServer.exe"

Path without spacing

C:\Users\Administrator\Desktop\mercy-framework\artifacts\FXServer.exe

txAdmin Recipe (Easiest)

In the following steps we'll be guiding you on how to download the Mercy Framework using recipe provided on our Github.

1. Start the setup process of txAdmin by opening the FXServer.exe file in your artifacts.
2. Create a txAdmin login.
3. Input a server name, choose Remote URL Template as the Deployment Type and input following link.

https://raw.githubusercontent.com/Mercy-Collective/mercy-framework-recipe/main/mercy.yaml

4. Select the default or a new folder path where the framework should install.

5. Click on "Go to Recipe Deployer" and click "Next".

6. Fill in your License Key and change the Database Options if required.

7. Click on "Run Recipe".

8. The Mercy Framework will now start installing.

9. When the installation has finished you'll see the server.cfg**, be sure to add a Steam Web API Key and change other settings to your likings.

10. Make sure to set following txAdmin Settings before joining the server:

    FXServer Settings (Parameters):

      +set sv_enforceGameBuild 3095
    

    FXServer Settings (OneSync):

    Legacy or Infinity

If you did above steps the server should be up and running! If not, we are more than happy to help you in our Discord Server.