on Windows
Prerequisites
- Visual C++ Redistributable 2019 or newer.
- Git to assure a correct installation.
Installation
- Create a new directory (for example
D:\FXServer\server
), this will be used for the server binaries. - Download the latest
master
branch build for Windows from the artifacts server. - Extract the build into the directory previously created.
3b. Use any archiving tool (such as WinRAR or 7-Zip). - Clone cfx-server-data in a new folder outside of your server binaries folder, for example,
D:\FXServer\server-data
.
4b.git clone https://github.com/citizenfx/cfx-server-data.git server-data
- Make a server.cfg file in your
server-data
folder (copy the example server.cfg file below into that file). - Generate a license key at https://keymaster.fivem.net. (login with the account you created!)
- Set the license key in your server.cfg using
sv_licenseKey "licenseKeyGoesHere"
. - Start the server from the
server-data
folder. For example, in a plain Windows command prompt (cmd.exe) window:cd /d D:\FXServer\server-data D:\FXServer\server\FXServer.exe +exec server.cfg
(the/d
flag is only needed when changing directory to somewhere on a different drive)
on Linux
- Create a new folder (for example
mkdir /home/username/FXServer/server
), this will be used for the server binaries. - Download the latest
master
branch build for Linux from the artifacts server(copy the URL for the latest server version and usewget <url>
to download it). - Extract the build to the directory that was previously created, using
cd /home/username/FXServer/server && tar xf fx.tar.xz
(you need to havexz
installed, on Debian/Ubuntu this is in thexz-utils
package). - Clone cfx-server-data in a new folder outside of your server binaries folder.
4b. For examplegit clone https://github.com/citizenfx/cfx-server-data.git /home/username/FXServer/server-data
- Make a server.cfg file in your
server-data
folder (copy the example server.cfg file below into that file). - Generate a license key at https://keymaster.fivem.net.
- Set the license key in your
server.cfg
usingsv_licenseKey "licenseKeyGoesHere"
. - Run the server from the
server-data
folder.
8b.bash /home/username/FXServer/server/run.sh +exec server.cfg
Add resources
- Open the resources folder in your FiveM server directory.
- Copy the resource you bought on our shop
- start the resource (server.cfg): add it to the config via
start RESOURCENAME