Skip to content
txAdmin - remotely manage&monitor your GTA5 FiveM Server
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data feature: discord messages Jun 10, 2019
docs rename: markdown files Jun 19, 2019
public rename: html files Jun 19, 2019
src rename: js files Jun 19, 2019
.gitignore admin adder script Jun 11, 2019
LICENSE Initial commit Apr 25, 2019
README.md rename: markdown files Jun 19, 2019
package-lock.json rename: repository links Jun 19, 2019
package.json fixed package.json -im an idiot Jun 19, 2019
version.json update checker + bumped version Jun 18, 2019

README.md

txAdmin for FiveM

FiveM Forum thread:  
Join our Discord Server:  

txAdmin (formerly known as FXAdmin) is a full featured tool to help you Manage & Monitor your FiveM Server remotely.


Features

  • Start/Stop/Restart your server instance or resources
  • Access control via multiple credentials and action logging
  • Discord integration (/status and configurable commands)
  • Monitor server’s CPU/RAM consumption
  • Real-time playerlist with ping + steam-linked accounts (when available)
  • OneSync Support (more than 32 slots server)
  • Linux Support
  • Live Console
  • Auto Restart on failure detection
  • Auto Restart on schedule
  • Password brute-force protection
  • Set FXServer process priority
  • Hitch Detection

Installation

First, make sure you have:

  • NodeJS v10+ (If you have problems with node-gyp/bcrypt/discord.js try downgrading to Node v10 LTS)
  • FXServer (duh)
  • One TCP listen port opened for the web server
  • Git (only for installs and updates)

1 - To INSTALL txAdmin execute:

$ git clone https://github.com/tabarra/txAdmin
$ cd txAdmin
$ npm i

2 - Copy your server-template.json to server.json and modify it according to your preferences. The most important settings:

  • global.fxServerPort is your fxServer port as configured in your server.cfg.
  • monitor.restarter.schedule is the restart schedule. The time MUST be in the 24-hour format with two digits for hours as well as minutes (HH:MM). Leave the array empty or set it to false to disable the feature.
  • fxRunner.buildPath is the folder containing the files run.cmd, fxserver.exe and a bunch of DLLs in case of Windows, and only run.sh in case of Linux.
  • fxRunner.basePath is the folder that contains the resources folder, usually it's here that you put your server.cfg.
  • fxRunner.cfgPath is the absolute or relative path of your server.cfg.

3 - To add an admin execute:

$ npm run admin-add

If you want to manage existing admins you must edit the JSON file yourself. Make sure your admins file folow admins-template.json. To generate the hashed password, you can use tools like this and this or even this one.

4 - To RUN txAdmin execute:

$ npm start server.json

Note: You should run FXServer through txAdmin, and not in parallel (ie in another terminal).
Note2: To configure your Discord bot, follow these two guides: Setting up a bot application and Adding your bot to servers.
Note3: Although not recommended, you can set FXServer processes priorities. To do so, change fxRunner.setPriority to one of the following: LOW, BELOW_NORMAL, NORMAL, ABOVE_NORMAL, HIGH, HIGHEST.

Troubleshooting

If you run into any problem, check our Troubleshooting Guide.

If you are having trouble starting the FXServer via txAdmin, run npm run config-tester server.json and see which test is failing.

Updating

To UPDATE txAdmin execute:

$ git pull
$ npm i

Make sure there's no differences in the json templates. If there is, copy the new template and edit again.
If you have any problems with the package-lock.json, just delete it and try again.

TODO:

  • Add custom commands to the config file
  • Config tester check for the modules inside package.json (require.resolve?)
  • Config tester kill spawned fxserver after 5 seconds
  • Investigate the "fxserver has stopped working" not disappearing when autorestarter kills the server (probably windows detaches it? in that case we would need to PID map and then kill them one by one?)

TODO Ideas...

  • We have data, we should plot it into a graph...
  • Get JSONC compatibility. Inline documentation for the configs would be great.
  • Multiple server support? Technically easy, but would require massive rework of the interface.
  • FXServer artifact/build auto updater???
  • Automagically send messages in discord when starting/stopping/restarting the server
  • Discord bot extensions via required js files? Imagine typing /whitelist @username and the bot cross referencing the vRP id via the discord:xxx identifier. Or a /me giving back this users vRP stats like cars, wallet, bank, apartments & etc.
  • Add some sort of detection to see if there is a fxserver running outside txAdmin on the same port.

The old TODO can be found here.

License & Credits

You can’t perform that action at this time.