NFive aims to be very easy to setup and configure, so you can quickly get a server up and running.
The recommended and easiest way to quickly install a FiveM server and setup NFive is to use the cross platform NFive Plugin Manager (
Download the latest version of
nfpm.exedoesn't need to be installed and can be run from anywhere.
Place it in the location you want to install the server and open a terminal/console window at that location.
nfpmwill work exactly the same on Linux/macOS if used with Mono:
Run the setup command
nfpm setupand answer the prompts, including how to connect to your database.
nfpmwill download the correct FiveM server for Windows or Linux depending on your platform.
You now have a complete server setup and can skip to Verifying Installation below.
To manually install NFive into a FiveM server, download the latest NFive release and extract it into your server's resources directory as
The resource will need to be included in your FiveM server configuration to start it:
NFive completely replaces all stock FiveM server resources; make sure you remove them from your configuration if you have installed any. FiveM server will always try to load a resource named
sessionmanager, even if it is not in your server configuration, so you must delete or rename the resource folder if its present.
NFive configuration files are located in
nfive/config/ with the primary configuration file being
NFive requires a MySQL database with the connection details being stored in
connection: host: localhost port: 3306 database: fivem user: root password: password charset: utf8mb4 logging: false
Your server directory should now contain a
server directory with a structure and key files similar to:
server/ ├── FXServer[.exe] |── server.cfg └── resources/ └── nfive/ ├── __resource.lua ├── nfive.yml ├── nfive.lock └── config/ ├── nfive.yml └── database.yml
The Linux FiveM server is more deeply nested with the server files located at
After running the setup command you will have a blank FiveM server with NFive installed and while it can now be started, without any plugins the server will be unusable to players.
See the next page Installing Plugins for the basic plugins needed to use your server.