eggs/game_eggs/gta/fivem/README.md

# FiveM

## Note on FiveM support from Pteroadactyl

Pterodactyl will not be providing support for FiveM. You are free to run a FiveM server but no support will be provided in the Pterodactyl Discord, check the discord annoucement below for details.

Worth a read if you plan on running a FiveM server
[Pterodactyl Discord Announcement](https://discord.com/channels/122900397965705216/124919575534895105/869733533495746560)

## From the [FiveM](https://fivem.net/) Site

FiveM is a modification for Grand Theft Auto V enabling you to play multiplayer on customized dedicated servers.

## Notice

Currently the script can get versions from the builds site.

The `FIVEM_VERSION` variable.

* Defaults to `latest` which is the latest recommended
* Can be set to a specific version Ex. `2431-350dd7bd5c0176216c38625ad5b1108ead44674d`.

The `DOWNLOAD_URL` only needs to be used if they turn on ddos protection. The variable needs to point to a `fx.tar.xz` file as I am too lazy to update the entire script.

## txAdmin

txAdmin is now supported and disabled by default. You set `TXADMIN_ENABLED` to `1` to enable it.

The last update to the egg changes the server to use txadmin to run. On first startup it will print a key to use to sign into the txadmin panel.

### Your server will not go online until it's started from txadmin

## Server Ports

Ports required to run the server in a table format.

| Port    | default |
|---------|---------|
| Game    | 30110   |
| Game+1  | 30120   |
| txAdmin | 40120   |
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00			`# FiveM`

			`## Note on FiveM support from Pteroadactyl`

			`Pterodactyl will not be providing support for FiveM. You are free to run a FiveM server but no support will be provided in the Pterodactyl Discord, check the discord annoucement below for details.`

			`Worth a read if you plan on running a FiveM server`
Don't use PTB as a link for the eggs. THis will cause people to have to re-log on the discord website :P 2022-08-08 23:06:40 +08:00			`[Pterodactyl Discord Announcement](https://discord.com/channels/122900397965705216/124919575534895105/869733533495746560)`
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00
update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			`## From the [FiveM](https://fivem.net/) Site`
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00
update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			`FiveM is a modification for Grand Theft Auto V enabling you to play multiplayer on customized dedicated servers.`
Updated FiveM README. 2018-11-06 07:16:04 +08:00
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00			`## Notice`

update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			`Currently the script can get versions from the builds site.`
update install script and readme update install script to use DOWNLOAD_URL update the readme to have a notice due to fivem changes 2019-09-11 22:37:25 +08:00
update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			The `FIVEM_VERSION` variable.
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00
update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			* Defaults to `latest` which is the latest recommended
			* Can be set to a specific version Ex. `2431-350dd7bd5c0176216c38625ad5b1108ead44674d`.
Updated FiveM README. 2018-11-06 07:16:04 +08:00
update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			The `DOWNLOAD_URL` only needs to be used if they turn on ddos protection. The variable needs to point to a `fx.tar.xz` file as I am too lazy to update the entire script.
Updated FiveM README. 2018-11-06 07:16:04 +08:00
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00			`## txAdmin`

Typo 2020-08-20 01:11:32 +08:00			txAdmin is now supported and disabled by default. You set `TXADMIN_ENABLED` to `1` to enable it.
disable txadmin by default adds a new flag to enable txadmin 2020-06-17 08:56:09 +08:00
			`The last update to the egg changes the server to use txadmin to run. On first startup it will print a key to use to sign into the txadmin panel.`
update fivem for txadmin Use txadmin instead of the old `+exec` command. 2020-06-03 08:53:01 +08:00
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00			`### Your server will not go online until it's started from txadmin`
update fivem for txadmin Use txadmin instead of the old `+exec` command. 2020-06-03 08:53:01 +08:00
update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			`## Server Ports`
added note about fivem and pterodactyl added link to pterodactyl fivem discord announcement fixed heading levels added blank lines as needed 2021-12-09 23:15:07 +08:00
Updated FiveM README. 2018-11-06 07:16:04 +08:00			`Ports required to run the server in a table format.`

			`\| Port \| default \|`
			`\|---------\|---------\|`
update fivem readme correct ports in table and update notice. 2020-05-26 20:50:30 +08:00			`\| Game \| 30110 \|`
update fivem for txadmin Use txadmin instead of the old `+exec` command. 2020-06-03 08:53:01 +08:00			`\| Game+1 \| 30120 \|`
Typo 2020-08-20 01:11:32 +08:00			`\| txAdmin \| 40120 \|`