Update forest readme

Updated Forest Readme
This commit is contained in:
tmunsch 2020-12-22 14:44:18 -05:00 committed by GitHub
parent 48b701ce84
commit a043f4a6bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,31 +1,20 @@
## FTB Modpacks
A generic service to pull FTB modpacks from api.modpacks.ch.
There are 2 ways to install a server through this service.
The first method only requires you to know the modpacks name and version.
The second method requires you to know the id for both the modpack and version in the api.
**Method 1 (Recommended)**
- FTB_SEARCH_TERM: the modpack name to query for, must be at least 4 characters long.
EX: for FTB: Interactions you would do "interactions".
- FTB_VERSION_STRING: the string version that you want to install.
EX: for FTB: Interactions 2.0.2, you would put "2.0.2".
## The Forest
As the lone survivor of a passenger jet crash, you find yourself in a mysterious forest battling to stay alive against a society of cannibalistic mutants.
Build, explore, survive in this terrifying first-person survival horror simulator.
**Method 2**
- FTB_MODPACK_ID: the id that directs to the modpack in the api.
EX: for FTB: Interactions the id would be "5". https://api.modpacks.ch/public/modpack/5
- FTB_MODPACK_VERSION_ID: the version id in the api.
EX: for FTB: Interactions 2.0.2 the id is "86". https://api.modpacks.ch/public/modpack/5/86
**NOTE**
**Not all FTB packs come with a server.properties file, due to this the server.properties file
may not get updated with the correct ip address and port at first launch.
Please restart the server after first launch to fix this.**
This server requires a Steam Token
You can generate the token on steam at https://steamcommunity.com/dev/managegameservers
## Server Ports
The minecraft server requires a single port for access (default 25565) but some plugins may require extra ports to enabled for the server.
The forest server requires three ports for access Server port (Default), Steam port (8766), Query Port (27016) but some plugins may require extra ports to enabled for the server.
| Port | default |
|-------|---------|
| Game | 25565 |
| Port | default |
|---------|---------|
| Server | any |
| Steam | 8766 |
| Query | 27016 |