Variables

FiveM

FiveM License

FiveM uses a license key to authenticate your server. You can get a license key from here. You can also use a key from a previous server, but this is not recommended.

When creating the key:

1. Name it something relevant to your server.
2. Look in our Discord to find the latest IP Address.
3. The server type is a VPS, and put AFK Hosting in the server provider field.

Then copy the Key and paste it in the FiveM License field on the panel.

Max Players

The maximum number of players that can join your server.
By default, your server supports up to 48 players at once. To have more playeres you need to join FiveM's Patreon. All server keys (even free keys) include all functionality if your server is set to 10 slots or less.

Server Hostname

The name of your server. This is what will show up in the server list.

FiveM Version

The version of FiveM you want to use.
You must change this to the version you want to use. Find the latest version here. Then right click on the latest version in the list and click "Copy Link".
NEVER CLIK ON THE LATEST RECOMMENDED OR THE LATEST OPTIONAL BUTTONS.
Paste that link in the FiveM Version field on the panel. Lastly remove everything but the numberes.

Example

https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/6645-9f45d7f6bb723304225304c82996bf58db073657/fx.tar.xz

becomes

6645-9f45d7f6bb723304225304c82996bf58db073657

Steam Web Api Key

This is used for Steam authentication. You can get a key from here. If you do not want to use Steam set the field to none.

Enable TxAdmin

If you want to use TxAdmin. Switch on the left and grey means TxAdmin will not be enabled. While the switch on the right and blue means TxAdmin will be enabled. Make sure to set a port for TxAdmin to use.
When using TxAdmin, follow this guide to set it up. If you are not using TxAdmin, follow this guide to set up your server.

TxAdmin Port

To use TxAdmin you need to set a port for it to use. To use a port, go to the Network tab and click "Create Allocation". Then you can add a note to the new allocation. This is the port you will use for TxAdmin. Click on the port number and paste it in the TxAdmin Port field on the panel.

Minecraft

Docker Image

You Must Change The Image To Java 17!

Server Jar File

The name of the server.jar file to run the server with. No need to change this unless you know what you are doing.

Server Version

The version of Minecraft you want to use. View the Release Changelogs here.

FiveM Discord Bot

Developer Mode

Developer Mode is required to be enabled to copy required IDs

To enable Developer Mode, go to your Discord settings, then go to Advanced, and enable Developer Mode.

Bot Token

The token for the Discord Bot. You can get a token from the Discord Developer Portal.
This bot should not be used by any other program(s) or servicses and should only be used for this application.

Client ID

The Client ID for the Discord Bot. You will also need the Client ID to invite the bot to your server(s). May also be called APPLICATION ID.
You can get the ID by going to your bot, under the General Information tab, and clicking Copy under the APPLICATION ID.

Guild/Server ID

The ID of the server you want the bot to be in.
You can get the ID by right clicking on the server name and clicking Copy ID.

Database Connection String

Your MYSQL database string.
To make one go to the DATABASES tab, then NEW DATABASE, give it a name, then click the eye icon, click the ROTATE PASSWORD button untill your password DOES NOT contain any of following characters:

#, $, ", ', =, @, :, /

When your password does not contain any of the characters, then click the JDBC CONNECTION STRING field and then close that panel. Go back to the Startup tab and paste the text into thix box. Makeing sure to REMOVE THE "jdbc:" FROM THE STRING so it starts with "mysql://".

Root Username

The default username to the admin user.
DO NOT share this with anyone. If you want to give somebody access to the bot, make a user for them in the web interface.

Root Password

The default password to the admin user.
DO NOT share this with anyone. If you want to give somebody access to the bot, make a user for them in the web interface.

Branch

If you wish to pull from a cretan branch of the reposotory.

warning

Other branches may not support pterodactyl, it is best to leave on main or leave blank.

SnailyCAD

info

More information on SnailyCAD can be found on their website.

Domain

The domain you might be using. (Optional, however, recommended)

warning

You may only set this when using a domain name.
This must be the TLD of the domain. (e.g.: example.com or mycommunity.com)

tip

Valid Examples:

• example.com
• example.com:3000 - a port can only be used when using a domain without SSL (https).

Invalid Examples:

• cad.example.com - subdomain cannot be used. must be top level domain
• 192.38.33.29 - an IP is not a domain

Client URL

The URL/IP to where the CAD is hosted at, see examples below.

tip

In support, this will be called the client.

Valid Examples:

• https://cad.example.com - subdomain
• https://mycad.com - Top level domain
• http://192.168.0.190:3000 - LAN IP-address
• http://83.39.20.30:3000 - WAN IP-address

Invalid Examples:

• localhost - will simply not work.
• cad.example.com - missing https:// or http://.
• http://192.168.x.x:3000 - default URL, will not work.

API URL

The URL/IP to where the API is hosted at (/v1 is required.), see examples below.

tip

In support, this will be called the API.

Valid Examples:

• https://cad-api.example.com/v1 - subdomain
• http://192.168.0.190:8080/v1 - LAN IP-address
• http://83.39.20.30:8080/v1 - WAN IP-address

Invalid Examples:

• https://cad-api.example.com - missing /v1
• cad-api.example.com - missing https:// or http://.
• localhost - will simply not work.
• http://192.168.x.x:8080/v1 - default URL, will not work.

Client Port

The port where the client should run on. Should be the same as your servers port.

API Port

The port where the API should run on. Must be created in the Network tab.
To create a port, go to the Network tab and click "Create Allocation". This is the port you will use for the API. Click on the port number, then copy and paste it in the API Port field.

Secure Cookies

Only enable when uterly required. (This may not work all the time; work-in-progress.)

Other fields

If you are looking in the .env file, you may see other fields. Please do not touch these as they may break the CAD.

License

Parts of this file are licensed under the MIT license. Some documentation provided by SnailyCAD.