tnovalis/fivem-servermanager

FiveM Server Manager

FiveM-ServerManager

A better FiveM Server Manager, _(*1)

Patreon - Discord, _(*2)

Features

• Install and update FiveM
• Servers
  • Add
  • Delete
  • Start, stop and restart
  • Console
• GUI Config
• Automatic server restarts
  • Timed and for crashes
• Automatic server backups

Installation

There are two ways to install FSM., _(*3)

Option One

Starting from 0.0.9 and after, in releases there is an executable file named fsm., _(*4)

You need to download this and put it into one of the locations in your $PATH, _(*5)

Also make sure it is marked executable chmod +x fsm, _(*6)

Currently you need to make the database file yourself (unless you are migrating from pre-v1). Do the following:, _(*7)

mkdir ~/.fsm
touch ~/.fsm/fsm.sqlite

Requirements

• PHP 7.1+
  • PHP MBString
  • PHP JSON
  • PHP SQLite3
• Linux
• Screen

Ubuntu 16+ users: sudo apt install php php-mbstring php-json php-sqlite3 screen, _(*8)

Option Two

You must have composer installed and its own requirements, _(*9)

Run the following command:, _(*10)

composer global require tnovalis/fivem-servermanager --no-dev

Once you do that you need to add your composer vendor bin to you $PATH, _(*11)

On Ubuntu, and most Linux distros this is in .config/composer/vendor/bin, _(*12)

If you use Bash for your shell you need to edit .profile to add it to your $PATH, _(*13)

Currently you need to make the database file yourself (unless you are migrating from pre-v1). Do the following:, _(*14)

mkdir ~/.fsm
touch ~/.fsm/fsm.sqlite

Requirements

• PHP 7.1+
  • PHP MBString
  • PHP JSON
  • PHP SQLite3
  • PHP Zip
• Linux
• Screen
• The few of composers requirements

Ubuntu 16+ users: sudo apt install php php-mbstring php-json php-zip composer screen, _(*15)

Upgrade Guide

Migrating from pre-v1 is simple, all you need to do is the following command:, _(*16)

fsm self:migrate

Usage

The first command you should run is this:, _(*17)

fsm fivem:install [<PATH>]

This will install FiveM and save the path for when starting the server., _(*18)

Since FiveM requires a license key, you must get one here FSM allows you to easily set it., _(*19)

fsm config:menu

Navigate to Set License, press Enter and put your license., _(*20)

After that I recommend running this:, _(*21)

fsm server:path [<PATH>]

This will set the server path, making it easier to create servers., _(*22)

If you want features such as the server automatically restarting after crashing, you need to use fsm schedule:run This is easy to setup., _(*23)

All you need to do is put the following into your cron:, _(*24)

* * * * * php /path/to/fsm schedule:run >> /dev/null 2>&1

No support will be given on how to access your cron file., _(*25)

Other Commands

To update FiveM, _(*26)

fsm fivem:update

To display all config settings, _(*27)

fsm config:dump

To create a server, _(*28)

fsm server:create [<NAME>] [<PATH>]

You don't need to specify the path if the server:path is set., _(*29)

To list the servers, _(*30)

fsm server:list --path

This will display a servers status and also check if a server crashed. You can also use --path to see the server's path in the table., _(*31)

To send a message to the server, _(*32)

fsm server:say [<NAME>] [<MESSAGE>]

The message must be in quotes unless you omit it in the initial command., _(*33)

To start a server, _(*34)

fsm server:start [<NAME>]

To stop a server, _(*35)

fsm server:stop [<NAME>] [--no-warning]

If you specify --no-warning the server will not send a message in chat about the shutdown., _(*36)

To restart a server schedulable, _(*37)

fsm server:restart [<NAME>] [--no-warning]

To backup a server schedulable, _(*38)

fsm server:backup [<NAME>]

This will output where it backed the server up to., _(*39)

To delete a server, _(*40)

fsm server:delete [<NAME>] [--no-backup]

If you specify --no-backup the server will not be backed up before removal., _(*41)

To rename a server, _(*42)

fsm server:rename [<NAME>] [<NEW-NAME>]

To fix crashed servers schedulable, _(*43)

fsm server:fix