Setup guide

Setup guide

ℹ️

We highly recommend using the txAdmin recipe over a manual installation.

txAdmin recipe

Download the latest stable artifact version.

Be sure to download version 12000 or higher. Don't use the "Latest Recommended" or "Latest Optional" buttons as they are very outdated.

Setup Database

⚠️

Do NOT use XAMPP, you will run into issues.

  • If you're on a VPS or dedicated server, Download & Install the latest version of MariaDB (opens in a new tab).
  • If you're on a Zap Hosting game server, you can read their documentation on how to setup a database or reach out to their support team.
⚠️

If you're on some other game server hosting, you should check out Prism Host (opens in a new tab) instead as using any host that isn't ZAP for game servers is against FiveM's Terms of Service & will result in your server or account being deleted.

Start the server setup

Where ever you installed the artifacts to, open the directory and launch fxserver.exe & follow the steps prompted.

Deploying the recipe

When prompted, select "Remote URL Template"

Choose the respective recipe for the server you want to deploy.

ND Main provides the full ND experience, including all released free resources and everything you need to create the best server possible. It also features the new character creation system.

ND Main
https://raw.githubusercontent.com/ND-Framework/txadmin-recipe/main/nd-main.yaml

Then continue.

Setup Recipe Information

When prompted to input the parameters for the recipe, be sure you fill out the database information to match the respective information. If you can't see it, click "Show/Hide Database options (advanced)"

Start the server

Once you have completed all of the steps, you can start the server. If you run into any issues, please see Common Issues or join our Discord (opens in a new tab) server

Manual installation

Download the latest stable artifact version.

Be sure to download version 12000 or higher. Don't use the "Latest Recommended" or "Latest Optional" buttons as they are very outdated.

Setup Database

⚠️

Do NOT use XAMPP, you will run into issues.

  • If you're on a VPS or dedicated server, Download & Install the latest version of MariaDB (opens in a new tab).
  • If you're on a Zap Hosting game server, you can read their documentation on how to setup a database or reach out to their support team.
⚠️

If you're on some other game server hosting, you should check out Prism Host (opens in a new tab) instead as using any host that isn't ZAP for game servers is against FiveM's Terms of Service & will result in your server or account being deleted.

Install & setup required dependencies

Install optional dependencies

Resource start order

server.cfg
start oxmysql
start ox_lib
start ND_Core
# all other resources below

Configuration

  • create a file and name it ndcore.cfg
  • copy paste the code below
  • write exec ndcore.cfg in your server.cfg
⚠️
Make sure exec ndcore.cfg is set before ND_Core is started!
    • server.cfg
    • ndcore.cfg
  • ndcore.cfg
    # Your servers name
    setr core:serverName "My FiveM Server"
     
    # Discord invite link
    setr core:discordInvite "https://discord.gg/Z9Mxu72zZ6"
     
    # Discord app id for rich presence
    setr core:discordAppId "858146067018416128"
     
    # Images for discord rich presence
    setr core:discordAsset "andyyy"
    setr core:discordAssetSmall "andyyy"
     
    # Buttons for discord rich presence
    setr core:discordActionText "DISCORD"
    setr core:discordActionLink "https://discord.gg/Z9Mxu72zZ6"
     
    setr core:discordActionText2 "STORE"
    setr core:discordActionLink2 "https://andyyy.tebex.io/category/fivem-scripts"
     
    # Used for getting users roles from your server, this can be useful for discord based scripts, if you don't add then it won't be used.
    # set core:discordGuildId "123456789012345678"
    # set core:discordBotToken "EXAMPLE_TOKEN.abc123.xyz456"
     
    # if set to true, and you have your discord token connected, users will have to join your discord to join your fivem server.
    set core:discordMemeberRequired false
     
    # The identifier to use for characters. Players aren't allowed to join without it, license is good don't change unless you know what you're doing.
    set core:characterIdentifier "license"
     
    # disable vehicle air contorl for cars and other land vehicles that's not supposed to do flips in air.
    setr core:disableVehicleAirControl true
     
    # % chance of random vehicles being unlocked.
    setr core:randomUnlockedVehicleChance 30
     
    # if true player must either hotwire a vehicle or have keys to start the engine.
    setr core:requireKeys true
     
    # If true it will use ox_inventory keys item for vehicles, if false it will use a keybind.
    setr core:useInventoryForKeys true
     
    # You can set admins here by their identifiers, admins will receive admin group in core and have access to group.admin ace perms.
    # You can also use Discord role ids, Admins get access to commands and more.
    set core:admins ["fivem:1459624", "fivem:1152629"]
    set core:adminDiscordRoles ["944284542758449212", "93422454258349612", "93345451558145232"]
     
    # Give groups for roles, this could be any group. If they player has the discord role they receive the group and ace perm with the same name.
    set core:groupRoles {
        "staff": ["955176855474929694", "1010595496915648624"]
    }
     
    # Compatibility with other frameworks, backwards is NDCore v1, if you're not using any of these compatible frameworks then remove them from this list. Available compatibility: ["backwards", "esx", "qb"]
    setr core:compatibility ["backwards"]
     
    # Allow ox_lib to use commands, don't remove this!
    add_ace resource.ox_lib command.add_ace allow
    add_ace resource.ox_lib command.remove_ace allow
    add_ace resource.ox_lib command.add_principal allow
    add_ace resource.ox_lib command.remove_principal allow
     
    # This is jobs, gangs, police, fire, ambulance, everything.
    # minumumBossRank is the mimimum rank a player becomes boss as, some scripts may utilize boss for different permissions.
    # Rank number is counted from left to right.
    setr core:groups {
        "unemployed": {
            "label": "Unemployed",
            "minimumBossRank": 1,
            "ranks": ["Unemployed"]
        },
        "sahp": {
            "label": "SAHP",
            "minimumBossRank": 5,
            "ranks": ["Trooper", "Senior Trooper", "Corporal", "Sergeant", "Lieutenant", "Chief"]
        },
        "lspd": {
            "label": "LSPD",
            "minimumBossRank": 5,
            "ranks": ["Officer", "Senior officer", "Corporal", "Sergeant", "Lieutenant", "Chief"]
        },
        "bcso": {
            "label": "BCSO",
            "minimumBossRank": 5,
            "ranks": ["Officer", "Senior officer", "Corporal", "Sergeant", "Lieutenant", "Chief"]
        },
        "swat": {
            "label": "SWAT",
            "minimumBossRank": 3,
            "ranks": ["Member", "Sniper", "Team lead", "Commander"]
        },
        "lsfd": {
            "label": "LSFD",
            "minimumBossRank": 5,
            "ranks": ["Volunteer", "Firefighter", "Senior firefighter", "Lieutenant", "Fire Chief"]
        },
        "ballas": {
            "label": "Ballas",
            "minimumBossRank": 2,
            "ranks": ["Member", "Leader"]
        },
        "families": {
            "label": "Families",
            "minimumBossRank": 2,
            "ranks": ["Member", "Leader"]
        },
        "cartel": {
            "label": "Madrazo Cartel",
            "minimumBossRank": 2,
            "ranks": ["Member", "Leader"]
        }
    }

    Common issues

    • attempt to index a nil value (global 'lib')
      • You're missing or didn't properly install ox_lib.
    • SCRIPT ERROR: @ND_Core/server/functions.lua:66: attempt to index a nil value (global 'MySQL')
      • You're missing or didn't properly install oxmysql.
    • Unable to establish a connection to the database
    • Error: ND_Core was unable to execute a query!
      • This is usually related to an outdated version of MariaDB or an issue with oxmysql. Please be sure you have the latest version installed, you are NOT using xampp or laragon and oxmysql successfully connects to your database.