Skip to content

Commit

Permalink
formated
Browse files Browse the repository at this point in the history
  • Loading branch information
Luxxy-GF committed Jun 25, 2024
1 parent c10147c commit afa1cb5
Showing 1 changed file with 24 additions and 26 deletions.
50 changes: 24 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,35 @@
# pterodactyl-fivem
# Pterodactyl-FiveM

## feature plans
I do plan on supporting [pelican](https://pelican.dev) and [pterodactyl](https://pterodactyl.io) at the same time when pelican first stable release comes out there will be two eggs to support this :)
## Feature Plans
I plan on supporting [Pelican](https://pelican.dev) and [Pterodactyl](https://pterodactyl.io) simultaneously when Pelican's first stable release comes out. There will be two eggs to support this. :)

## About
This is a script to install FiveM on a Debian 12 server. It will install the latest version of FiveM and automatically keep it updated. It will also install the latest version of FXServer.
This script installs FiveM on a Debian 12 server. It installs the latest version of FiveM and automatically keeps it updated. It also installs the latest version of FXServer.

## Installation
1. Download the egg from the [Releases](https://github.com/Luxxy-GF/pterodactyl-fivem/releases/latest)
2. Upload the egg to your panel
3. Create a new server and select the FiveM egg
4. Start the server and wait for it to install
5. Once the server is started, stop it
1. Download the egg from the [Releases](https://github.com/Luxxy-GF/pterodactyl-fivem/releases/latest).
2. Upload the egg to your panel.
3. Create a new server and select the FiveM egg.
4. Start the server and wait for it to install.
5. Once the server is started, stop it.

## Updating
1. Go to the `Startup` tab
2. Change the `Auto Update` to the desired value (default: `1` | `0` = disabled, `1` = enabled) note: this will delete `alpine` folder and reinstall it `no data will be lost`
1. Go to the `Startup` tab.
2. Change the `Auto Update` to the desired value (default: `1` | `0` = disabled, `1` = enabled). Note: This will delete the `alpine` folder and reinstall it; no data will be lost.

## Notice

The `FIVEM_VERSION` variable.

* Defaults to `latest` which is the latest optional artifact.
* Can be set to a specific version Ex. `7549-801114291131277b01c25158b4261df6efbbc610`.
* If the `Auto Update` Button is turned on when you press th `Reinstall Server` button the `alpine` folder will be replaced with an updated version.
The `FIVEM_VERSION` variable:
- Defaults to `latest`, which is the latest optional artifact.
- Can be set to a specific version, e.g., `7549-801114291131277b01c25158b4261df6efbbc610`.
- If the `Auto Update` button is turned on when you press the `Reinstall Server` button, the `alpine` folder will be replaced with an updated version.

## Server Ports

Ports required to run the server in a table format. You only need the txAdmin port if you plan to enable txAdmin.

| Port | default |
| - | - |
| FiveM | 30120 |
| txAdmin | 40120 |
| Port | Default |
|---------|---------|
| FiveM | 30120 |
| txAdmin | 40120 |

## Credits
- [Luxxy-GF](https://github.com/Luxxy-GF) - Creator of the egg
Expand All @@ -40,10 +38,10 @@ Ports required to run the server in a table format. You only need the txAdmin po
- [parkervcp](https://github.com/parkervcp) - Creator of the original egg

## Support
If you need help with this egg, you can create a issue on this repo
If you need help with this egg, you can create an issue on this repo.

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## pull request
if you want to help me with this egg you can create a pull request
## Pull Requests
If you want to help with this egg, you can create a pull request at [pterodactyl-fivem](https://github.com/Luxxy-GF/pterodactyl-fivem).

0 comments on commit afa1cb5

Please sign in to comment.