diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c28c9d5f..67d02ffe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,47 +2,51 @@ ## General rules -1. Keep it simple. - We don't need 8 miles of install script. -2. Keep it Small. - Only use what is absolutely needed. +1. Keep it simple. + We don't need 8 miles of install script. -3. Try to stay in the stock containers. - If you need something in a container, open a PR in [my yolks repo](https://github.com/parkervcp/yolks) where I can review and pull it up to the main repo. In addition, there is a larger quantity of [images here](https://github.com/parkervcp/images) for you to use that have not been migrated to Yolks yet. +2. Keep it Small. + Only use what is absolutely needed. -4. Don't be afraid to submit PR's to the egg repo. - I don't bite. I will work with you on the egg and the required things to run it. +3. Try to stay in the stock containers. + If you need something in a container, open a PR in [my yolks repo](https://github.com/parkervcp/yolks) where I can review and pull it up to the main repo. In addition, there is a larger quantity of [images here](https://github.com/parkervcp/images) for you to use that have not been migrated to Yolks yet. -## Step 1. +4. Don't be afraid to submit PR's to the egg repo. + I don't bite. I will work with you on the egg and the required things to run it. -#### Be aware of the pterodactyl install process. +## Step 1 + +### Be aware of the pterodactyl install process The Pterodactyl install process is fairly simple once you know. +```md 1. Spin up install container This uses a volume mount on /mnt/server for the server files. This can pull or set up all that is needed to run the server. It is regularly used to just download the files required. Such as server files and configs. + 2. Stop install container 3. Start a new container with the server files in /home/container This is where the server is actually run. Any dependencies installed during the install process are gone. The container that is started should have everything you need. +``` -## Step 2. +## Step 2 -#### Testing +### Testing Make sure your install process is rock solid as I will be testing eggs before they ever hit my repo. -I will make suggestions and changes at will. +I will make suggestions and changes at will. This is to maintain a clean repo that others can pull and be fully aware of what is being done. -## Step 3. +## Step 3 -#### Make a branch and do your work in there. +### Make a branch and do your work in there I have been getting messy PR's due to people always PRing from their master branch. Please make a seperate branch and PR from there. diff --git a/README.md b/README.md index 006e4acf..8e25472d 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,14 @@ If you are reading this it looks like you are looking to add an egg to your serv 5. Select what nest you want to put the egg in. 1. If you want a new nest you need to create it before importing the egg. -# You must restart your daemon after importing an egg if you are using 0.7. This is not required on 1.X. - +## You must restart your daemon after importing an egg if you are using 0.7. This is not required on 1.X ## Please read the CONTRIBUTING.md before submitting PRs ## [Bots](/bots) [Discord](/bots/discord) + * [ATL Bot](/bots/discord/atlbot) Node JS * [Bastion](/bots/discord/bastion) Node JS * [CorpBot](/bots/discord/corpbot) Python @@ -43,43 +43,56 @@ If you are reading this it looks like you are looking to add an egg to your serv * [SinusBot](/bots/discord/sinusbot) [Other](/bots/other) + * [Big Brother Bot](/bots/other/bigbrotherbot) [Twitch](/bots/twitch) - * [PhantomBot](/bots/twitch/phantombot) - * [SogeBot](/bots/twitch/sogebot) + +* [PhantomBot](/bots/twitch/phantombot) +* [SogeBot](/bots/twitch/sogebot) [TeamSpeak3](bots/teamspeak3) - * [JTS3ServerMod](/bots/teamspeak3/jts3servermod) + +* [JTS3ServerMod](/bots/teamspeak3/jts3servermod) ## [Database](/database) + ### In-Memory Databases + [Redis](/database/redis) + * [Redis 5](/database/redis/redis-5) * [Redis 6](/database/redis/redis-6) ### noSQL + * [mongoDB](/database/nosql/mongodb) ### SQL Databases + * [MariaDB](/database/sql/mariadb) * [PostgreSQL](/database/sql/postgres) ## [Voice Servers](/voice_servers) + * [Lavalink](/voice_servers/lavalink) * [TeaSpeak](/voice_servers/teaspeak) * [TS3-Manager](/voice_servers/ts3_manager) ## [Game Eggs](/game_eggs) + [Among Us](game_eggs/among_us) + * [Impostor Server](game_eggs/among_us/impostor_server) * [CrewLink Server](game_eggs/among_us/crewlink_server) [BeamNG.drive](game_eggs/beamng) + * [BeamMP Server](game_eggs/beamng/beammp) * [KissMP](game_eggs/beamng/kissmp) [ClassiCube](game_eggs/classicube) + * [MCGalaxy](game_eggs/classicube/mcgalaxy) [Call of Duty 4X](game_eggs/cod/cod4x) @@ -89,10 +102,12 @@ If you are reading this it looks like you are looking to add an egg to your serv [FTL: Tachyon](game_eggs/ftl/tachyon) [Factorio](game_eggs/factorio) + * [Vanilla](game_eggs/factorio/factorio) * [ModUpdate](game_eggs/factorio/factorio-modupdate) [Grand Theft Auto](game_eggs/gta) + * GTA V * [FiveM](game_eggs/gta/fivem) * [RageMP](game_eggs/gta/ragemp) @@ -106,28 +121,32 @@ If you are reading this it looks like you are looking to add an egg to your serv * [GTAC](game_eggs/gta/gtac) [Mindustry](game_eggs/mindustry) - * [Mindustry](game_eggs/mindustry/mindustry) + +* [Mindustry](game_eggs/mindustry/mindustry) [League Sandbox](game_eggs/leaguesandbox) - * [League Sandbox](game_eggs/leaguesandbox/leaguesandbox) + +* [League Sandbox](game_eggs/leaguesandbox/leaguesandbox) [Minetest](game_eggs/minetest) (including MTG) - * [Minetest](game_eggs/minetest/minetest) + +* [Minetest](game_eggs/minetest/minetest) [Minecraft](game_eggs/minecraft) + * [Bedrock](game_eggs/minecraft/bedrock) Servers for Bedrock Minecraft (Windows 10, mobile, console) * [Bedrock](game_eggs/minecraft/bedrock/bedrock) * [gomint](game_eggs/minecraft/bedrock/gomint) - * [Nukkit](game_eggs/minecraft/bedrock/nukkit) - * [PocketMine MP](game_eggs/minecraft/bedrock/pocketmine_mp) + * [Nukkit](game_eggs/minecraft/bedrock/nukkit) + * [PocketMine MP](game_eggs/minecraft/bedrock/pocketmine_mp) * [Java](game_eggs/minecraft/java) Servers for Java Minecraft * [Airplane](game_eggs/minecraft/java/airplane) * [Cuberite](game_eggs/minecraft/java/cuberite) * [Fabric](game_eggs/minecraft/java/fabric) - * [Feather](game_eggs/minecraft/java/feather) - * [Feed The Beast](game_eggs/minecraft/java/ftb) - * [Forge](game_eggs/minecraft/java/forge) + * [Feather](game_eggs/minecraft/java/feather) + * [Feed The Beast](game_eggs/minecraft/java/ftb) + * [Forge](game_eggs/minecraft/java/forge) * [Magma](game_eggs/minecraft/java/magma) * [Mohist](game_eggs/minecraft/java/mohist) * [NanoLimbo](/game_eggs/minecraft/java/nanolimbo) @@ -142,7 +161,7 @@ If you are reading this it looks like you are looking to add an egg to your serv * [Proxies](game_eggs/minecraft/proxy) Minecraft Server Proxies * [Java](game_eggs/minecraft/proxy/java) - * [FlameCord](game_eggs/minecraft/proxy/java/flamecord) + * [FlameCord](game_eggs/minecraft/proxy/java/flamecord) * [Travertine](game_eggs/minecraft/proxy/java/travertine) * [TyphoonLimbo](game_eggs/minecraft/proxy/java/typhoonlimbo) * [Velocity](game_eggs/minecraft/proxy/java/velocity) @@ -153,18 +172,22 @@ If you are reading this it looks like you are looking to add an egg to your serv * [GeyserMC](game_eggs/minecraft/proxy/cross_platform/geyser) * [Waterdog](game_eggs/minecraft/proxy/cross_platform/waterdog) -[OpenArena](game_eggs/openarena) - * [openarena](game_eggs/openarena/openarena) +[OpenArena](game_eggs/openarena) + +* [openarena](game_eggs/openarena/openarena) [OpenRA](game_eggs/openra) + * [OpenRA Dune2000](game_eggs/openra/openra_dune2000) * [OpenRA Red Alert](game_eggs/openra/openra_red_alert) * [OpenRA Tiberian Dawn](game_eggs/openra/openra_tiberian_dawn) [Red Dead Redemption](game_eggs/rdr) + * [RedM](game_eggs/rdr/redm) [SteamCMD Servers](game_eggs/steamcmd_servers) These eggs use SteamCMD to install + * [7 Days to Die](game_eggs/steamcmd_servers/7_days_to_die) * [ARK: Survival Evolved](game_eggs/steamcmd_servers/ark_survival_evolved) * [Arma](game_eggs/steamcmd_servers/arma) @@ -221,9 +244,11 @@ If you are reading this it looks like you are looking to add an egg to your serv * [Valheim Plus Mod](game_eggs/steamcmd_servers/valheim/valheim_plus) [Teeworlds](game_eggs/teeworlds) + * [Teeworlds](game_eggs/teeworlds/teeworlds) [Terraria](game_eggs/terraria) + * [Vanilla](game_eggs/terraria/vanilla) * [tModLoader](game_eggs/terraria/tmodloader) * [TShock](game_eggs/terraria/tshock) @@ -241,23 +266,39 @@ If you are reading this it looks like you are looking to add an egg to your serv [Xonotic](game_eggs/xonotic/xonotic) ## [Monitoring](/monitoring/) + ### Prometheus + * [Prometheus](/monitoring/prometheus) ## [Storage](/storage/) + ### S3 Storage + * [minio](/storage/minio) ## [Software](/software/) + ### Code Server + * [Code-Server](/software/code-server) + ### Elasticsearch + * [Elasticsearch](/software/elasticsearch) + ### Gitea + * [Gitea](/software/gitea) + ### Grafana + * [Grafana](/software/grafana) + ### haste-server + * [haste-server](/software/haste-server) + ### RabbitMQ + * [rabbitmq](/software/rabbitmq) diff --git a/bots/discord/README.md b/bots/discord/README.md index 99f02d57..6d7490ad 100644 --- a/bots/discord/README.md +++ b/bots/discord/README.md @@ -1,56 +1,69 @@ # Discord Bots -### Some of these bots support other services but are primarily Discord bots +## Some of these bots support other services but are primarily Discord bots -#### ATLauncher Discord Bot -[ATLauncher/discord-bot](https://github.com/ATLauncher/discord-bot) -Their github has all the info you need +### [ATLauncher Discord Bot](atlbot) -#### Bastion -[TheBastionBot/Bastion](https://github.com/TheBastionBot/Bastion) +[ATLauncher/discord-bot](https://github.com/ATLauncher/discord-bot) +Their github has all the info you need + +### [Bastion](bastion) + +[TheBastionBot/Bastion](https://github.com/TheBastionBot/Bastion) Give awesome perks to your Discord server! -### Corpbot +### [Corpbot](corpbot) + [corpnewt/CorpBot.py](https://github.com/corpnewt/CorpBot.py) A very clumsy python bot for discord -#### DiscordJS -[discord.js](https://discord.js.org/) +### [DiscordJS](discord.js) + +[discord.js](https://discord.js.org/) A generic discord.js egg for running discord bots. -#### DiscordPY -[discord.py](https://discordpy.readthedocs.io/en/latest/) +### [DiscordPY](discord.py) + +[discord.py](https://discordpy.readthedocs.io/en/latest/) A generic discord.py egg for running discord bots. -#### discordgo +### [discordgo](discordgo) + [discordgo](https://github.com/bwmarrin/discordgo) A generic go application egg. -#### FragBot -[fragforce/fragbot](https://github.com/fragforce/fragbot) -The bot that runs as the fragforce `@Fragbot` offering looking-for-group services for now +### [FragBot](fragbot) -#### MusicBot -[jagrosh/MusicBot](https://github.com/jagrosh/MusicBot) -A Discord music bot that's easy to set up and run yourself! +[fragforce/fragbot](https://github.com/fragforce/fragbot) +The bot that runs as the fragforce `@Fragbot` offering looking-for-group services for now -#### nodemon -[nodemon](https://nodemon.io/) +### [JMusicBot](jmusicbot) + +[jagrosh/MusicBot](https://github.com/jagrosh/MusicBot) +A Discord music bot that's easy to set up and run yourself! + +### [nodemon](nodemon.js) + +[nodemon](https://nodemon.io/) A nodemon javascript egg for running and automatically restarting the node application when file changes in the directory are detected -#### parkertron -[parkervcp/parkertron](https://github.com/parkervcp/parkertron) -The bot that runs as the pterodactyl `@Support Bot` +### [parkertron](parkertron) -#### PixelBot -[possatti/pixelbot](https://github.com/possatti/pixelbot) -No longer actively developed. -Was used to test python services. +[parkervcp/parkertron](https://github.com/parkervcp/parkertron) +The bot that runs as the pterodactyl `@Support Bot` + +### [PixelBot](pixelbot) + +[possatti/pixelbot](https://github.com/possatti/pixelbot) +No longer actively developed. +Was used to test python services. + +### [RedBot](redbot) -### RedBot [Cog-Creators/Red-DiscordBot](https://github.com/Cog-Creators/Red-DiscordBot) A multifunction Discord bot -#### SinusBot -[SinusBot](https://www.sinusbot.com/) +### [SinusBot](sinusbot) + +[SinusBot](https://www.sinusbot.com/) Please Check their site for an in depth on the bot. diff --git a/bots/discord/atlbot/README.md b/bots/discord/atlbot/README.md index 008d3906..f20d135c 100644 --- a/bots/discord/atlbot/README.md +++ b/bots/discord/atlbot/README.md @@ -1,6 +1,9 @@ # ATLBot -### Their [Github](https://github.com/ATLauncher/discord-bot) + +## Their [Github](https://github.com/ATLauncher/discord-bot) + This is the code for our Discord bot which runs on the official ATLauncher Discord server -### Server Ports -There are no ports required for the atl bot \ No newline at end of file +## Server Ports + +There are no ports required for the atl bot diff --git a/bots/discord/bastion/README.md b/bots/discord/bastion/README.md index 1dc840db..06e0baf1 100644 --- a/bots/discord/bastion/README.md +++ b/bots/discord/bastion/README.md @@ -1,13 +1,18 @@ # Bastion -### From their [Github](https://github.com/TheBastionBot/Bastion) -Give awesome perks to your Discord server! -### Install notes -Due to rate limiting the console on the panel cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. +## From their [Github](https://github.com/TheBastionBot/Bastion) + +Give awesome perks to your Discord server! + +## Install notes + +Due to rate limiting the console on the panel cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. ## Running the bot + You need to enable both `Privileged Gateway Intents` for the bot to run. Enable this from `https://discord.com/developers/applications//bot` -### Server Ports -No Ports are required for the bastion bot. \ No newline at end of file +## Server Ports + +No Ports are required for the bastion bot. diff --git a/bots/discord/corpbot/README.md b/bots/discord/corpbot/README.md index 8fd994f9..20d8c2b2 100644 --- a/bots/discord/corpbot/README.md +++ b/bots/discord/corpbot/README.md @@ -1,8 +1,11 @@ # CorpBot.py -### From their [Github](https://github.com/corpnewt/CorpBot.py) -A very clumsy python bot for discord -### Server Ports +## From their [Github](https://github.com/corpnewt/CorpBot.py) + +A very clumsy python bot for discord + +## Server Ports + No ports are required to run CorpBot. You can assign a random port to the bot. -#### Mods/Plugins may require ports to be added to the server. +### Mods/Plugins may require ports to be added to the server diff --git a/bots/discord/deno/README.md b/bots/discord/deno/README.md index bf981cfc..4e47367d 100644 --- a/bots/discord/deno/README.md +++ b/bots/discord/deno/README.md @@ -1,6 +1,6 @@ # Deno generic -### From their [site](https://deno.land/) +## From their [site](https://deno.land/) This egg is designed to run any generic Deno application, allowing users to pull their own Deno discord bot from a Github repository. @@ -9,14 +9,16 @@ There is an option to allow a user to upload their own files to run a server. The startup configs and commands may need changing to actually function properly. ## Configuration + The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. ![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) You can use arrays to have multiple different values when different bots are being used -``` + +```json { "done":[ "change this text 1", "change this text 2" ] -} \ No newline at end of file +} diff --git a/bots/discord/discord.java/README.md b/bots/discord/discord.java/README.md index 1f18f7d4..57d230ed 100644 --- a/bots/discord/discord.java/README.md +++ b/bots/discord/discord.java/README.md @@ -1,4 +1,5 @@ # discord.java generic + This egg is designed to run any generic Java application, allowing users to pull their own Java discord bot from a Github repository. There is an option to allow a user to upload their own files to run a bot. @@ -6,14 +7,16 @@ There is an option to allow a user to upload their own files to run a bot. The startup configs and commands may need changing to actually function properly. ## Configuration + The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. ![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) You can use arrays to have multiple different values when different bots are being used -``` + +```json { "done":[ "change this text 1", "change this text 2" ] -} \ No newline at end of file +} diff --git a/bots/discord/discord.js/README.md b/bots/discord/discord.js/README.md index cab8f28f..1d7a903d 100644 --- a/bots/discord/discord.js/README.md +++ b/bots/discord/discord.js/README.md @@ -7,11 +7,13 @@ There is an option to allow a user to upload their own files to run a bot. The startup configs and commands may need changing to actually function properly. ## Configuration + The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. ![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) You can use arrays to have multiple different values when different bots are being used -``` + +```json { "done":[ "change this text 1", diff --git a/bots/discord/discord.py/README.md b/bots/discord/discord.py/README.md index 80b3ffb5..2a823146 100644 --- a/bots/discord/discord.py/README.md +++ b/bots/discord/discord.py/README.md @@ -1,4 +1,5 @@ # discord.py generic + This egg is designed to run any generic Python application, allowing users to pull their own Python discord bot from a Github repository. There is an option to allow a user to upload their own files to run a bot. @@ -6,14 +7,16 @@ There is an option to allow a user to upload their own files to run a bot. The startup configs and commands may need changing to actually function properly. ## Configuration + The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. ![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) You can use arrays to have multiple different values when different bots are being used -``` + +```json { "done":[ "change this text 1", "change this text 2" ] -} \ No newline at end of file +} diff --git a/bots/discord/discordgo/README.md b/bots/discord/discordgo/README.md index 02aaf500..9aaf837b 100644 --- a/bots/discord/discordgo/README.md +++ b/bots/discord/discordgo/README.md @@ -1,22 +1,25 @@ # discordgo generic + This egg is designed to run any generic Golang application, allowing users to pull their own Golang discord bot from a Github repository. The startup configs and commands may need changing to actually function properly. Users cannot upload their own code as this is built to build the resulting bot. -`GO_PACKAGE` is the variable for the go repo i.e. `github.com/aurieh/ddg-ng` +`GO_PACKAGE` is the variable for the go repo i.e. `github.com/aurieh/ddg-ng` `EXECUTABLE` is the variable for the executable that is built i.e. `ddg-ng` ## Configuration + The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. ![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) You can use arrays to have multiple different values when different bots are being used -``` + +```json { "done":[ "change this text 1", "change this text 2" ] -} \ No newline at end of file +} diff --git a/bots/discord/fragbot/README.md b/bots/discord/fragbot/README.md index 6ef6eedd..2ffdb8d7 100644 --- a/bots/discord/fragbot/README.md +++ b/bots/discord/fragbot/README.md @@ -1,8 +1,11 @@ # fragbot -### Their [Github](https://github.com/fragforce/fragbot) -The golang based discord bot for fragforce. + +## Their [Github](https://github.com/fragforce/fragbot) + +The golang based discord bot for fragforce. Runs the fragforce `@fragbot` -### Server Ports -There are no ports required for fragbot \ No newline at end of file +## Server Ports + +There are no ports required for fragbot diff --git a/bots/discord/jmusicbot/README.md b/bots/discord/jmusicbot/README.md index addeb37b..67c1252d 100644 --- a/bots/discord/jmusicbot/README.md +++ b/bots/discord/jmusicbot/README.md @@ -1,6 +1,9 @@ # JMusicBot + ___ -### Authors / Contributors + +## Authors / Contributors + @@ -51,7 +54,9 @@ ___ ___ -### Bot Description & Features + +## Bot Description & Features + From the developer's [Github](https://github.com/jagrosh/MusicBot): > A Discord music bot that's easy to set up and run yourself! @@ -65,17 +70,25 @@ From the developer's [Github](https://github.com/jagrosh/MusicBot): - Supports many online radio/streams - Supports local files - Playlist support (both web/youtube, and local) + ___ -### Configuration + +## Configuration + - If you can, edit the Startup Variables before starting the bot, because otherwise it will fail to start. - Most settings found in `config.txt` can be edited via the Startup Variables. Advanced settings not listed can still be edited manually via the File Manager. Available Startup Variables will take precedent over manual edits. + ___ -### Server Ports + +## Server Ports + There are no ports required for JMusicBot. ___ -### Updating + +## Updating + Re-Installing the server via the panel will do the following: 1. Update the bot to the latest version. 2. Update the `config.txt` file to the latest version, and place the old one at `config.txt-old`. -3. Any local songs will remain and not be touched. \ No newline at end of file +3. Any local songs will remain and not be touched. diff --git a/bots/discord/lua/luvit/README.md b/bots/discord/lua/luvit/README.md index 8c51a6c3..5a4114c2 100644 --- a/bots/discord/lua/luvit/README.md +++ b/bots/discord/lua/luvit/README.md @@ -4,4 +4,4 @@ This egg was designed to allow a user to pull their own lua discord bot from a r There is an option to allow a user to upload their own files to run a bot. -The startup configs and commands may need changing to actually function properly. \ No newline at end of file +The startup configs and commands may need changing to actually function properly. diff --git a/bots/discord/nodemon.js/README.md b/bots/discord/nodemon.js/README.md index 4b4f695b..c50d7e1a 100644 --- a/bots/discord/nodemon.js/README.md +++ b/bots/discord/nodemon.js/README.md @@ -11,11 +11,13 @@ There is an option to allow a user to upload their own files to run a bot. The startup configs and commands may need changing to actually function properly. ## Configuration + The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. ![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) You can use arrays to have multiple different values when different bots are being used -``` + +```json { "done":[ "change this text 1", diff --git a/bots/discord/parkertron/README.md b/bots/discord/parkertron/README.md index e66546f7..24975d02 100644 --- a/bots/discord/parkertron/README.md +++ b/bots/discord/parkertron/README.md @@ -1,8 +1,11 @@ # parkertron -### Their [Github](https://github.com/parkervcp/parkertron) -Purely a chatbot. Not even a smart one. + +## Their [Github](https://github.com/parkervcp/parkertron) + +Purely a chatbot. Not even a smart one. Runs the Pterodactyl `@support bot` -### Server Ports -There are no ports required for parkertron \ No newline at end of file +## Server Ports + +There are no ports required for parkertron diff --git a/bots/discord/pixelbot/README.md b/bots/discord/pixelbot/README.md index 4726344e..99c92060 100644 --- a/bots/discord/pixelbot/README.md +++ b/bots/discord/pixelbot/README.md @@ -1,9 +1,13 @@ # pixelbot -### Their [Github](https://github.com/possatti/pixelbot) -Bot for pixelcanvas.io -### Server Ports +## Their [Github](https://github.com/possatti/pixelbot) + +Bot for pixelcanvas.io + +## Server Ports + There are no ports required for pixelbot -### Side notes -This was to make sure the parkervcp/images:python 3 image worked. \ No newline at end of file +## Side notes + +This was to make sure the parkervcp/images:python 3 image worked. diff --git a/bots/discord/redbot/README.md b/bots/discord/redbot/README.md index cad24c5a..64a78c16 100644 --- a/bots/discord/redbot/README.md +++ b/bots/discord/redbot/README.md @@ -1,16 +1,20 @@ # Red-DiscordBot -### From their [Github](https://github.com/Cog-Creators/Red-DiscordBot) -A multifunction Discord bot -### Server Ports +## From their [Github](https://github.com/Cog-Creators/Red-DiscordBot) + +A multifunction Discord bot + +## Server Ports + No port are required to run Red. if you want to use the internal Lavalink Server, you need to allocate port 2333 as primary -### Additional Requirements +## Additional Requirements + When using the Audio Cog the bot will attempt to save files to /tmp resulting in a disk space error. You may also see this same error when attempting to install a cog, due to pip using /tmp to build the requirements. To resolve this error you must increase the size of `tmpfs` using custom container policy. -For additional details see: -https://pterodactyl.io/wings/1.0/configuration.html#other-values +For additional details see: + -#### Mods/Plugins may require ports to be added to the server. +### Mods/Plugins may require ports to be added to the server diff --git a/bots/discord/sinusbot/README.md b/bots/discord/sinusbot/README.md index 9fe05294..81ab0f0f 100644 --- a/bots/discord/sinusbot/README.md +++ b/bots/discord/sinusbot/README.md @@ -1,15 +1,19 @@ # SinusBot -### Their [Site](https://www.sinusbot.com/) -Listen to your favorite music together with all of your friends -Welcome the Simple, Elegant & great sounding TS3- and Discord-Bot! +## Their [Site](https://www.sinusbot.com/) + +Listen to your favorite music together with all of your friends + +Welcome the Simple, Elegant & great sounding TS3- and Discord-Bot! + +## Server Ports -### Server Ports 1 port is required to run SinusBot. | Port | default | |---------|---------| | Game | 8087 | -### Side notes -This uses a custom image. \ No newline at end of file +## Side notes + +This uses a custom image. diff --git a/bots/other/bigbrotherbot/README.md b/bots/other/bigbrotherbot/README.md index 7ff6f9e6..27580e60 100644 --- a/bots/other/bigbrotherbot/README.md +++ b/bots/other/bigbrotherbot/README.md @@ -1,8 +1,11 @@ # Big Brother Bot -### From their [Github](https://github.com/BigBrotherBot/big-brother-bot) -Big Brother Bot B3 is a complete and total server administration package for online games. B3 is designed primarily to keep your server free from the derelicts of online gaming, but offers more, much more -### Server Ports +## From their [Github](https://github.com/BigBrotherBot/big-brother-bot) + +Big Brother Bot B3 is a complete and total server administration package for online games. B3 is designed primarily to keep your server free from the derelicts of online gaming, but offers more, much more + +## Server Ports + No ports are required to run Big Brother Bot. You can assign a random port to the bot. -#### Mods/Plugins may require ports to be added to the server. \ No newline at end of file +### Mods/Plugins may require ports to be added to the server diff --git a/bots/teamspeak3/README.md b/bots/teamspeak3/README.md index f430ca9f..f6362c22 100644 --- a/bots/teamspeak3/README.md +++ b/bots/teamspeak3/README.md @@ -1,7 +1,8 @@ # TeamSpeak3 Bots -### Some of these bots support other services but are primarily TeamSpeak3 bots +## Some of these bots support other services but are primarily TeamSpeak3 bots -#### JTS3ServerMod -[JTS3ServerMod](https://www.stefan1200.de/forum/index.php?topic=2.0) -Please Check their site for an in depth on the bot. \ No newline at end of file +### [JTS3ServerMod](jts3servermod) + +[JTS3ServerMod](https://www.stefan1200.de/forum/index.php?topic=2.0) +Please Check their site for an in depth on the bot. diff --git a/bots/twitch/README.md b/bots/twitch/README.md index 8c12388f..365ec895 100644 --- a/bots/twitch/README.md +++ b/bots/twitch/README.md @@ -1,6 +1,15 @@ # Twitch Bots -### Some of these bots support other services but are primarily Twitch bots +## Some of these bots support other services but are primarily Twitch bots -#### PhantomBot [Homepage](https://phantombot.github.io/PhantomBot/) [Egg](/bots/twitch/phantombot/) -#### sogeBot [Homepage](https://sogebot.xyz) [Egg](/bots/twitch/sogebots/) +### [PhantomBot](phantombot) + +[Website](https://phantombot.github.io/PhantomBot/) +[GitHub](https://github.com/phantombot/PhantomBot) +PhantomBot is an actively developed open source interactive Twitch bot with a vibrant community that provides entertainment and moderation for your channel, allowing you to focus on what matters the most to you - your game and your viewers. + +### [SogeBot](sogebot) + +[Website](https://sogebot.xyz) +[GitHub](https://github.com/sogebot/sogeBot) +Free Twitch Bot built on Node.js diff --git a/bots/twitch/phantombot/README.md b/bots/twitch/phantombot/README.md index de58899c..ab9e186f 100644 --- a/bots/twitch/phantombot/README.md +++ b/bots/twitch/phantombot/README.md @@ -1,10 +1,11 @@ # PhantomBot -### Their [Site](https://phantombot.github.io/PhantomBot/) -PhantomBot is an actively developed open source interactive Twitch bot -with a vibrant community that provides entertainment and moderation for your channel, -allowing you to focus on what matters the most to you - your game and your viewers. -### Server Ports +[WebSite](https://phantombot.github.io/PhantomBot/) +[GitHub](https://github.com/phantombot/PhantomBot) +PhantomBot is an actively developed open source interactive Twitch bot with a vibrant community that provides entertainment and moderation for your channel, allowing you to focus on what matters the most to you - your game and your viewers. + +## Server Ports + 3 ports are required to run PhantomBot. | Port | default | @@ -13,7 +14,8 @@ allowing you to focus on what matters the most to you - your game and your viewe | YoutubeSocketServer | 25003 | | PanelSocketServer | 25004 | -# NOTES +### NOTES + You need to define one main port and the other 2 port need to be +3 and +4! Example: diff --git a/bots/twitch/sogebot/README.md b/bots/twitch/sogebot/README.md index c2c82425..02a15492 100644 --- a/bots/twitch/sogebot/README.md +++ b/bots/twitch/sogebot/README.md @@ -1,15 +1,17 @@ # SogeBot -### Their [Site](https://www.sogebot.xyz) -sogeBot is an actively developed open source interactive Twitch bot that provides entertainment and moderation for your channel, -allowing you to focus on what matters the most to you - your game and your viewers. -### Server Ports +[Website](https://sogebot.xyz) +[GitHub](https://github.com/sogebot/sogeBot) +Free Twitch Bot built on Node.js + +## Server Ports + 1 port is required to run sogeBot. | Port | default | |---------------------|---------| | Game (HTTP Server) | 20000 | -#NOTES +## NOTES The installation take a long time, because a lot of things must be compiled. It can take 5 or more minutes !!! diff --git a/database/README.md b/database/README.md index 0c58f9a3..9efc7435 100644 --- a/database/README.md +++ b/database/README.md @@ -1,16 +1,23 @@ # databases ## In-Memory Databases + ### [redis](/redis/) + https://redis.io/ ## NoSQL + ### [mongodb](/nosql/mongodb/) + https://www.mongodb.com/ ## SQL Databases + ### [mariadb](/sql/mariadb/) + https://mariadb.org/ ### [postgres](/sql/postgres/) - https://www.postgresql.org/ \ No newline at end of file + + https://www.postgresql.org/ diff --git a/database/nosql/mongodb/README.md b/database/nosql/mongodb/README.md index 9a2f5090..0a6415ae 100644 --- a/database/nosql/mongodb/README.md +++ b/database/nosql/mongodb/README.md @@ -1,12 +1,15 @@ # mongoDB -### From their [Website](https://www.mongodb.com/) -MongoDB is a general purpose, document-based, distributed database built for modern application developers and for the cloud era. -### Minimum RAM warning +## From their [Website](https://www.mongodb.com/) + +MongoDB is a general purpose, document-based, distributed database built for modern application developers and for the cloud era. + +## Minimum RAM warning + MongoDB requires approximately 1GB of RAM per 100.000 assets. If the system has to start swapping memory to disk, this will have a severely negative impact on performance, and should be avoided. +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | diff --git a/database/redis/redis-5/README.md b/database/redis/redis-5/README.md index 4c89fc87..3531c1d1 100644 --- a/database/redis/redis-5/README.md +++ b/database/redis/redis-5/README.md @@ -1,14 +1,17 @@ # Redis -### From their [Website](https://redis.io/) + +## From their [Website](https://redis.io/) + Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. -### Minimum RAM warning +## Minimum RAM warning + It's recommended to have 4gb of RAM for redis -See here https://docs.redislabs.com/latest/rs/administering/designing-production/hardware-requirements/ +See here +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | diff --git a/database/redis/redis-6/README.md b/database/redis/redis-6/README.md index 4c89fc87..3531c1d1 100644 --- a/database/redis/redis-6/README.md +++ b/database/redis/redis-6/README.md @@ -1,14 +1,17 @@ # Redis -### From their [Website](https://redis.io/) + +## From their [Website](https://redis.io/) + Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. -### Minimum RAM warning +## Minimum RAM warning + It's recommended to have 4gb of RAM for redis -See here https://docs.redislabs.com/latest/rs/administering/designing-production/hardware-requirements/ +See here +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | diff --git a/database/sql/mariadb/README.md b/database/sql/mariadb/README.md index 10acde47..51c8f277 100644 --- a/database/sql/mariadb/README.md +++ b/database/sql/mariadb/README.md @@ -1,15 +1,18 @@ # MariaDB -### From their [Website](https://mariadb.org/) -One of the most popular database servers. Made by the original developers of MySQL. -Guaranteed to stay open source. -### Minimum RAM warning +## From their [Website](https://mariadb.org/) + +One of the most popular database servers. Made by the original developers of MySQL. +Guaranteed to stay open source. + +## Minimum RAM warning + There is no actual minimum suggested for MariaDB. -See here https://mariadb.com/kb/en/library/mariadb-hardware-requirements/ +See here +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | diff --git a/database/sql/postgres/README.md b/database/sql/postgres/README.md index 68feb186..317c23e5 100644 --- a/database/sql/postgres/README.md +++ b/database/sql/postgres/README.md @@ -1,14 +1,17 @@ # PostgreSQL -### From their [Website](https://www.postgresql.org/) -The World's Most Advanced Open Source Relational Database -### Minimum RAM warning +## From their [Website](https://www.postgresql.org/) + +The World's Most Advanced Open Source Relational Database + +## Minimum RAM warning + 2 Gigabytes minimum recommended -See here https://www.commandprompt.com/blog/postgresql_mininum_requirements/ +See here +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | diff --git a/example/README.md b/example/README.md index 94d7f62b..5b9852aa 100644 --- a/example/README.md +++ b/example/README.md @@ -1,20 +1,46 @@ # Example Server Name -### From their [Github](https://github.com/parkervcp/eggs) -A link to the site that you download game files from. -The description of the server usually provided by the game/server maker. -### Install notes -Due to rate limiting the console on the panel cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. + + +## From their [Github](https://github.com/parkervcp/eggs) + +A link to the site that you download the server files from. + +## [Documentation](https://github.com/parkervcp/eggs/blob/master/README.md) + +A link to relevent documentation for the server. + +The description of the server usually provided by the game/server maker. + + +## Install notes + + +Due to rate limiting the console on the panel, it cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. + +## Minimum RAM warning -### Minimum RAM warning Minimum required memory to run the server. + +## Minumim Sorage warning + +Minimum required storage to run the server. + + + + +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | |---------|---------| | Game | 25565 | -#### Mods/Plugins may require ports to be added to the server. +### Notes + + +25565 is the default port, but any port can be used. + +### Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/README.md b/game_eggs/README.md index 43aafbc4..1499e1f6 100644 --- a/game_eggs/README.md +++ b/game_eggs/README.md @@ -1,61 +1,65 @@ -## Game Eggs +# Game Eggs + [Among Us](among_us) + * [Impostor Server](among_us/impostor_server) * [CrewLink Server](among_us/crewlink_server) [BeamNG.drive](beamng) + * [BeamMP Server](beamng/beammp) * [KissMP](beamng/kissmp) [ClassiCube](game_eggs/classicube) + * [MCGalaxy](game_eggs/classicube/mcgalaxy) [Call of Duty 4X](cod/cod4x) [ET Legacy](enemy_territory/etlegacy) -[FTL: Tachyon](ftl/tachyon) - [Factorio](factorio) + * [Vanilla](factorio/factorio) * [ModUpdate](factorio/factorio-modupdate) +[FTL: Tachyon](ftl/tachyon) + [Grand Theft Auto](gta) + * GTA V * [FiveM](gta/fivem) * [RageMP](gta/ragemp) * [alt:V](gta/altv) - + * GTA SA * [Multi Theft Auto](gta/mtasa) * [SA-MP](gta/samp) - + * GTA * [GTAC](gta/gtac) -[Mindustry](mindustry) - * [Mindustry](mindustry/mindustry) - [League Sandbox](leaguesandbox) - * [League Sandbox](leaguesandbox/leaguesandbox) -[Minetest](minetest) (including MTG) - * [Minetest](minetest/minetest) +[Mindustry](mindustry) [Minecraft](minecraft) + * [Bedrock](minecraft/bedrock) Servers for Bedrock Minecraft (Windows 10, mobile, console) * [Bedrock](minecraft/bedrock/bedrock) * [gomint](minecraft/bedrock/gomint) - * [Nukkit](minecraft/bedrock/nukkit) - * [PocketMine MP](minecraft/bedrock/pocketmine_mp) + * [Nukkit](minecraft/bedrock/nukkit) + * [PocketMine MP](minecraft/bedrock/pocketmine_mp) * [Java](minecraft/java) Servers for Java Minecraft * [Airplane](minecraft/java/airplane) * [Cuberite](minecraft/java/cuberite) - * [Fabric](minecraft/java/fabric) - * [Feather](minecraft/java/feather) - * [Feed The Beast](minecraft/java/ftb) + * [Fabric](minecraft/java/fabric) + * [Feather](minecraft/java/feather) * [Forge](minecraft/java/forge) + * [Forge](minecraft/java/forge/forge) + * [CusreForge Generic](minecraft/java/forge/curseforge-generic) + * [Feed The Beast](minecraft/java/ftb) * [Krypton](/minecraft/java/krypton) * [Magma](minecraft/java/magma) * [Mohist](minecraft/java/mohist) @@ -70,28 +74,37 @@ * [VanillaCord](minecraft/java/vanillacord) * [Proxies](minecraft/proxy) Minecraft Server Proxies - * [Java](minecraft/proxy/java) - * [FlameCord](minecraft/proxy/java/flamecord) - * [Travertine](minecraft/proxy/java/travertine) - * [TyphoonLimbo](minecraft/proxy/java/typhoonlimbo) - * [Velocity](minecraft/proxy/java/velocity) - * [Waterfall](minecraft/proxy/java/waterfall) + * [Bedrock](minecraft/proxy/bedrock) + * [Waterdog PE](minecraft/proxy/bedrock/waterdog_pe) * [Cross Platform](minecraft/proxy/cross_platform) * [GeyserMC](minecraft/proxy/cross_platform/geyser) * [Waterdog](minecraft/proxy/cross_platform/waterdog) + * [Java](minecraft/proxy/java) + * [FlameCord](minecraft/proxy/java/flamecord) + * [Travertine](minecraft/proxy/java/travertine) + * [TyphoonLimbo](minecraft/proxy/java/typhoonlimbo) + * [Velocity](minecraft/proxy/java/velocity) + * [VIAaas](minecraft/proxy/java/viaaas) + * [Waterfall](minecraft/proxy/java/waterfall) -[OpenArena](openarena) - * [openarena](openarena/openarena) +[Minetest](minetest) (including MTG) + +[OpenArena](openarena) [OpenRA](openra) + * [OpenRA Dune2000](openra/openra_dune2000) * [OpenRA Red Alert](openra/openra_red_alert) * [OpenRA Tiberian Dawn](openra/openra_tiberian_dawn) [Red Dead Redemption](rdr) + * [RedM](rdr/redm) +[Starmade](starmade) + [SteamCMD Servers](steamcmd_servers) These eggs use SteamCMD to install + * [7 Days to Die](steamcmd_servers/7_days_to_die) * [ARK: Survival Evolved](steamcmd_servers/ark_survival_evolved) * [Arma](steamcmd_servers/arma) @@ -101,7 +114,6 @@ * [Barotrauma](steamcmd_servers/barotrauma) * [Citadel: Forged with Fire](steamcmd_servers/citadel) * [Conan Exiles](steamcmd_servers/conan_exiles) -* [Craftopia](steamcmd_servers/craftopia) * [CryoFall](steamcmd_servers/cryofall) * [Don't Starve Together](steamcmd_servers/dont_starve) * [ECO](steamcmd_servers/eco) @@ -129,9 +141,9 @@ * [Staging](steamcmd_servers/rust/rust_staging) * [Satisfactory](steamcmd_servers/satisfactory) * [SCP: Secret Laboratory](steamcmd_servers/scpsl) - * [dedicated](steamcmd_servers/scpsl/dedicated) - * [exiled](steamcmd_servers/scpsl/exiled) - * [multiadmin](steamcmd_servers/scpsl/multiadmin) + * [Dedicated](steamcmd_servers/scpsl/dedicated) + * [Exiled](steamcmd_servers/scpsl/exiled) + * [Multiadmin](steamcmd_servers/scpsl/multiadmin) * [Soldat](steamcmd_servers/soldat) * [Space Engineers](steamcmd_servers/space_engineers) * [Squad](steamcmd_servers/squad) @@ -140,31 +152,28 @@ * [Stormworks: Build and Rescue](steamcmd_servers/stormworks) * [Subnautica: Nitrox Mod](steamcmd_servers/subnautica_nitrox_mod) * [Sven Co-op](steamcmd_servers/svencoop) -* [The Forest](steamcmd_servers/the_forest) * [Team Fortress 2 Classic](steamcmd_servers/team_fortress_2_classic) +* [The Forest](steamcmd_servers/the_forest) +* [Tower Unite](steamcmd_servers/tower_unite) * [Unturned](steamcmd_servers/unturned) * [Valheim](steamcmd_servers/valheim) - * [Valheim Vanilla](steamcmd_servers/valheim/valheim_vanilla) * [Valheim Plus Mod](steamcmd_servers/valheim/valheim_plus) + * [Valheim Vanilla](steamcmd_servers/valheim/valheim_vanilla) [Teeworlds](teeworlds) -* [Teeworlds](teeworlds/teeworlds) [Terraria](terraria) -* [Vanilla](terraria/vanilla) + * [tModLoader](terraria/tmodloader) * [TShock](terraria/tshock) +* [Vanilla](terraria/vanilla) [Tycoon Games](tycoon_games) * [OpenRCT2](tycoon_games/openrct2) * [OpenTTD](tycoon_games/openttd) -[Unreal Engine](unreal_engine) -* [Tower Unite](unreal_engine/tower_unite) -* [Tower Unite](steamcmd_servers/tower_unite) +[Veloren](veloren) -[Veloren](veloren/veloren) - -[Vintage Story](vintage_story/vintage_story) +[Vintage Story](vintage_story) [Xonotic](xonotic/xonotic) diff --git a/game_eggs/among_us/README.md b/game_eggs/among_us/README.md index 42fa5f9f..a87d34a4 100644 --- a/game_eggs/among_us/README.md +++ b/game_eggs/among_us/README.md @@ -1,7 +1,7 @@ # Among Us -[CrewLink Server](crewlink_server) +[CrewLink Server](crewlink_server) This project implements proximity voice chat in Among Us. Everyone in an Among Us lobby with this program running will be able to communicate over voice in-game, with no third-party programs required. -[Impostor Server](impostor_server) -Impostor is one of the first Among Us private servers, written in C#. \ No newline at end of file +[Impostor Server](impostor_server) +Impostor is one of the first Among Us private servers, written in C#. diff --git a/game_eggs/among_us/crewlink_server/README.md b/game_eggs/among_us/crewlink_server/README.md index 871ce5d9..14264cfd 100644 --- a/game_eggs/among_us/crewlink_server/README.md +++ b/game_eggs/among_us/crewlink_server/README.md @@ -1,7 +1,15 @@ # Among Us - CrewLink Server -### From their [Github](https://github.com/ottomated/CrewLink) + +## From their [Github](https://github.com/ottomated/CrewLink) This project implements proximity voice chat in Among Us. Everyone in an Among Us lobby with this program running will be able to communicate over voice in-game, with no third-party programs required. Spatial audio ensures that you can only hear people close to you. -### Server Port -Default port is 9736 but you can change to any port or domain/ip in the egg \ No newline at end of file +## Server Port + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Game | 9736 | + +Default port is 9736 but you can change to any port or domain/ip in the egg diff --git a/game_eggs/among_us/impostor_server/README.md b/game_eggs/among_us/impostor_server/README.md index f0e9d9c0..4a0b2088 100644 --- a/game_eggs/among_us/impostor_server/README.md +++ b/game_eggs/among_us/impostor_server/README.md @@ -1,14 +1,16 @@ # Among Us - Impostor Server -### From their [Github](https://github.com/AeonLucid/Impostor) + +## From their [Github](https://github.com/AeonLucid/Impostor) Impostor is one of the first Among Us private servers, written in C#. There are no special features at this moment, the goal is aiming to be as close as possible to the real server, for now. In a later stage, making modifications to game logic by modifying GameData packets can be looked at. -### Install notes +## Install notes You MUST use Port 22023 for the Master Server. To host multiple servers, please read [Impostor Multiple Servers Documentation](https://github.com/Impostor/Impostor/blob/master/docs/Running-the-server.md#multiple-servers). -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | diff --git a/game_eggs/beamng/README.md b/game_eggs/beamng/README.md index 95cceb92..80b3c68f 100644 --- a/game_eggs/beamng/README.md +++ b/game_eggs/beamng/README.md @@ -3,4 +3,4 @@ BeamMP Bringing Multiplayer to BeamNG.drive! With a smooth and enjoyable experience. * [BeamMP Server](beammp) -* [KissMP](kissmp) \ No newline at end of file +* [KissMP](kissmp) diff --git a/game_eggs/beamng/beammp/README.md b/game_eggs/beamng/beammp/README.md index b4e401bf..a2844bc3 100644 --- a/game_eggs/beamng/beammp/README.md +++ b/game_eggs/beamng/beammp/README.md @@ -1,7 +1,6 @@ - # BeamMP BeamMP Bringing Multiplayer to BeamNG.drive! With a smooth and enjoyable experience. * [BeamMP Server](game_eggs/beamng/beammp) -* [KissMP](game_eggs/beamng/kissmp) \ No newline at end of file +* [KissMP](game_eggs/beamng/kissmp) diff --git a/game_eggs/beamng/kissmp/README.md b/game_eggs/beamng/kissmp/README.md index 0aaed1e9..49a9c6ad 100644 --- a/game_eggs/beamng/kissmp/README.md +++ b/game_eggs/beamng/kissmp/README.md @@ -1,5 +1,5 @@ # BeamNG.drive - KISS Multiplayer -### From their [Github](https://github.com/TheHellBox/KISS-multiplayer) +## From their [Github](https://github.com/TheHellBox/KISS-multiplayer) Server settings such as the map can be changed in the `config.json` file. Port is automatically set on each boot. diff --git a/game_eggs/classicube/mcgalaxy/README.md b/game_eggs/classicube/mcgalaxy/README.md index ce3248fa..08717160 100644 --- a/game_eggs/classicube/mcgalaxy/README.md +++ b/game_eggs/classicube/mcgalaxy/README.md @@ -1,10 +1,11 @@ # Classicube MCGalaxy -[MCGalaxy](https://github.com/UnknownShadow200/MCGalaxy) + +[MCGalaxy](https://github.com/UnknownShadow200/MCGalaxy) MCGalaxy is a fully featured and customisable ClassiCube Server Software based on MCForge/MCLawl. +## Server Ports | Port | default | |---------|---------| | Game | 25565 | - diff --git a/game_eggs/cod/cod4x/README.md b/game_eggs/cod/cod4x/README.md index bbb6555e..a1b5047c 100644 --- a/game_eggs/cod/cod4x/README.md +++ b/game_eggs/cod/cod4x/README.md @@ -1,20 +1,22 @@ # Call of Duty 4X ## Game files mounting + The server does **not** contain the base game files, but they are necessary to use the server. While the server itself is open-source, the game files are copyrighted and you will need to own a legitimate copy of the game (Call of Duty 4: Modern Warfare) in order to provide the game files to the server. -More information here: https://github.com/callofduty4x/CoD4x_Server#setting-up-a-call-of-duty-4-server-with-cod4x-18 +More information here: + +## Correctly mounting the game files -### Correctly mounting the game files In order to give the server access to the needed game files you will need to create a new mount. Let's say you copied the game files to your node into the directory `/home/pterodactyl/serverfiles/cod4x` (you can choose any directory you want of course). The directory structure will look like this:
- -``` + +```md /home/pterodactyl/serverfiles/cod4x ├── main │ ├── iw_00.iwd @@ -115,16 +117,20 @@ The directory structure will look like this:
3 directories, 93 files ``` +
First of all add the directory of the mount to the config.yml (in `/etc/pterodactyl`) of your node. -``` + +```md allowed_mounts: - /home/pterodactyl/serverfiles ``` + After you've done this, restart wings with `systemctl restart wings`. Now you simply create a mount in the Pterodactyl Panel with the following settings: + 1. Set the source to `/home/pterodactyl/serverfiles/cod4x` 2. Set the target to any directory you want (but not something in `/home/container`, I suggest something like `/mnt/gamefiles/cod4`) 3. Set read-only to "true" ("false" will also work, but then you risk that one instance overwrites files for all other instances) @@ -134,21 +140,23 @@ Now you simply create a mount in the Pterodactyl Panel with the following settin 7. Add the CoD4X egg to the list of eggs for the mount ### Correctly configuring the servers -In order for the server to find the game files you have to set "Game file path" variable in the server to the same directory that you used in the "target" field of the mount. + +In order for the server to find the game files you have to set "Game file path" variable in the server to the same directory that you used in the "target" field of the mount. When you start the server for the first time it will prompt you to mount the game files under the configured path. + 1. In the admin interface open your server 2. Go to the tab "Mounts" 3. Klick on the green "+" button on the correct mount in order to mount the game files 4. Restart the server - **Congratulations!** Your server should be able to find the game files and start. ## Default Server Ports + The default is 28960, but the server will automatically use the port defined in the allocation. | Port | default | |---------|---------| | Game | 28960 | -#### Plugins may require ports to be added to the server. +### Plugins may require ports to be added to the server diff --git a/game_eggs/enemy_territory/etlegacy/README.md b/game_eggs/enemy_territory/etlegacy/README.md index 43b83406..09555dd7 100644 --- a/game_eggs/enemy_territory/etlegacy/README.md +++ b/game_eggs/enemy_territory/etlegacy/README.md @@ -1,20 +1,20 @@ # ET: Legacy -#### The ET: Legacy Server +## The ET: Legacy Server - -#### from the developers +## from the developers Wolfenstein: Enemy Territory is a free multiplayer first-person shooter. Set during World War II and heavily focused on team work, it was initially released in 2003 by Splash Damage and id Software. More than a decade after its release, after spending countless hours of escorting tanks and trucks, stealing gold and radar parts and transmitting confidential documents, it was time to dust off the game which consistently refused to go down. -Enemy Territory: Legacy is an open source project based on the code of Wolfenstein: Enemy Territory which was released in 2010 under the terms of GPLv3 license. The main goal of this project is to fix bugs, remove old dependencies and make it playable on all major operating systems while still remaining compatible with the ET 2.60b version and as many of its mods as possible. We do appreciate any contribution to the project such as patches, suggestions or comments. +Enemy Territory: Legacy is an open source project based on the code of Wolfenstein: Enemy Territory which was released in 2010 under the terms of GPLv3 license. The main goal of this project is to fix bugs, remove old dependencies and make it playable on all major operating systems while still remaining compatible with the ET 2.60b version and as many of its mods as possible. We do appreciate any contribution to the project such as patches, suggestions or comments. Make sure to checkout their [Home Page](https://www.etlegacy.com/). -### Server Ports -ET: Legacy requires a single port +## Server Ports + +ET: Legacy requires a single port | Port | default | |---------|---------| -| Game | 27960 | \ No newline at end of file +| Game | 27960 | diff --git a/game_eggs/factorio/README.md b/game_eggs/factorio/README.md index 714d66d2..5095e4a6 100644 --- a/game_eggs/factorio/README.md +++ b/game_eggs/factorio/README.md @@ -1,12 +1,13 @@ # Factorio -#### The Factorio Server -The server supports mods. -The factorio-modupdate egg uses the factorio-mod-updater (https://github.com/pdemonaco/factorio-mod-updater) to update your mods when ReInstalling the Server. +## The Factorio Server -#### from the developers +The server supports mods. +The factorio-modupdate egg uses the [factorio-mod-updater](https://github.com/pdemonaco/factorio-mod-updater) to update your mods when ReInstalling the Server. -Factorio is a game in which you build and maintain factories. +## from the developers + +Factorio is a game in which you build and maintain factories. You will be mining resources, researching technologies, building infrastructure, automating production and fighting enemies. Use your imagination to design your factory, combine simple elements into ingenious structures, apply management skills to keep it working, and protect it from the creatures who don't really like you. @@ -16,9 +17,10 @@ Factorio has been in development since the spring of 2012. So far over 1,400,000 New to the game? Make sure to checkout their [starter page](https://factorio.com/starter-page). -### Server Ports -Factorio requires a single port +## Server Ports + +Factorio requires a single port | Port | default | |---------|---------| -| Game | 34197 | \ No newline at end of file +| Game | 34197 | diff --git a/game_eggs/ftl/tachyon/README.MD b/game_eggs/ftl/tachyon/README.MD index c4c03499..cfccac50 100644 --- a/game_eggs/ftl/tachyon/README.MD +++ b/game_eggs/ftl/tachyon/README.MD @@ -12,4 +12,4 @@ The Tachyon server requires a single port for access. ## Server Specific -Latest client and standalone server can be found at https://github.com/Dav-Edward/TachyonsCE/releases +Latest client and standalone server can be found at diff --git a/game_eggs/gta/README.md b/game_eggs/gta/README.md index 2847f0a3..d79f00a7 100644 --- a/game_eggs/gta/README.md +++ b/game_eggs/gta/README.md @@ -1,11 +1,11 @@ -# Grand Theft Auto +# Grand Theft Auto ## GTA V -[FiveM](https://fivem.net/) -FiveM is a modification for Grand Theft Auto V enabling you to play multiplayer on customized dedicated servers. +[FiveM](https://fivem.net/) +FiveM is a modification for Grand Theft Auto V enabling you to play multiplayer on customized dedicated servers. -[Rage MP](https://rage.mp/) +[Rage MP](https://rage.mp/) RAGE Multiplayer is an multiplayer modification for Grand Theft Auto V that is alternative to GTA Online. [alt:V](https://altv.mp) @@ -13,10 +13,10 @@ alt:V Multiplayer a third-party multiplayer modification for Grand Theft Auto: V ## San Andreas -[GTA SA:MP](https://www.sa-mp.com/) -SA-MP is a free Massively Multiplayer Online game mod for the PC version of Rockstar Games Grand Theft Auto: San Andreas (tm). +[GTA SA:MP](https://www.sa-mp.com/) +SA-MP is a free Massively Multiplayer Online game mod for the PC version of Rockstar Games Grand Theft Auto: San Andreas (tm). -[MTA SA](https://mtasa.com/) +[MTA SA](https://mtasa.com/) What more could you want? Multi Theft Auto provides the best online Grand Theft Auto experience there is. Read on to find out more. ## GTAC diff --git a/game_eggs/gta/altv/README.md b/game_eggs/gta/altv/README.md index dddd7a36..25850aeb 100644 --- a/game_eggs/gta/altv/README.md +++ b/game_eggs/gta/altv/README.md @@ -1,9 +1,11 @@ # alt:v -### From the [alt:V](https://altv.mp) Site +## From the [alt:V](https://altv.mp) Site + alt:V Multiplayer a third-party multiplayer modification for Grand Theft Auto: V. -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | diff --git a/game_eggs/gta/fivem/README.md b/game_eggs/gta/fivem/README.md index 25c312f2..12f44451 100644 --- a/game_eggs/gta/fivem/README.md +++ b/game_eggs/gta/fivem/README.md @@ -1,24 +1,37 @@ -# FiveM +# 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://ptb.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 +## 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 + 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. +### 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 | diff --git a/game_eggs/gta/gtac/README.md b/game_eggs/gta/gtac/README.md index fe3be939..b32b1f37 100644 --- a/game_eggs/gta/gtac/README.md +++ b/game_eggs/gta/gtac/README.md @@ -1,10 +1,11 @@ # Grand Theft Auto Connected + The [GTAC](https://gtaconnected.com/) Grand Theft Auto Connected is a custom scriptable multiplayer modification for multiple Grand Theft Auto games. -### Server Ports +## Server Ports GTAC requires one port for both UDP/TCP | Port | default | |---------|----------| -| Game | 22000 | \ No newline at end of file +| Game | 22000 | diff --git a/game_eggs/gta/mtasa/README.md b/game_eggs/gta/mtasa/README.md index ed5c0ff2..171b0eae 100644 --- a/game_eggs/gta/mtasa/README.md +++ b/game_eggs/gta/mtasa/README.md @@ -1,7 +1,8 @@ # Multi Theft Auto + [Multi Theft Auto](https://mtasa.com/) is a Open Source Grand Theft Auto: San Andreas Multiplayer modification. -### Server Ports +## Server Ports Multi Theft Auto requires 3 ports. diff --git a/game_eggs/gta/ragemp/README.MD b/game_eggs/gta/ragemp/README.MD index b35e9c35..62b9c3e2 100644 --- a/game_eggs/gta/ragemp/README.MD +++ b/game_eggs/gta/ragemp/README.MD @@ -1,12 +1,13 @@ # Rage-MP -The [Rage-MP](https://rage.mp/) GTA 5 dedicated server + +The [Rage-MP](https://rage.mp/) GTA 5 dedicated server RAGE Multiplayer is an multiplayer modification for Grand Theft Auto V that is alternative to GTA Online. -### Server Ports +## Server Ports Warband requires a 2 ports (default 22005, 22006) | Port | default | |---------|----------| | Game | 22005 | -| http | 22006 | \ No newline at end of file +| http | 22006 | diff --git a/game_eggs/gta/samp/README.md b/game_eggs/gta/samp/README.md index d4fcf00c..dff71cfd 100644 --- a/game_eggs/gta/samp/README.md +++ b/game_eggs/gta/samp/README.md @@ -1,2 +1,3 @@ # SA:MP -The [SA:MP](https://www.sa-mp.com/) GTA San Andreas dedicated server \ No newline at end of file + +The [SA:MP](https://www.sa-mp.com/) GTA San Andreas dedicated server diff --git a/game_eggs/leaguesandbox/leaguesandbox/LeagueSandbox_Egg.json b/game_eggs/leaguesandbox/LeagueSandbox_Egg.json similarity index 100% rename from game_eggs/leaguesandbox/leaguesandbox/LeagueSandbox_Egg.json rename to game_eggs/leaguesandbox/LeagueSandbox_Egg.json diff --git a/game_eggs/leaguesandbox/leaguesandbox/README.md b/game_eggs/leaguesandbox/README.md similarity index 70% rename from game_eggs/leaguesandbox/leaguesandbox/README.md rename to game_eggs/leaguesandbox/README.md index e5022466..136badf3 100644 --- a/game_eggs/leaguesandbox/leaguesandbox/README.md +++ b/game_eggs/leaguesandbox/README.md @@ -1,19 +1,25 @@ # League Sandbox -### From their [Github](https://github.com/parkervcp/eggs) + +## From their [Github](https://github.com/LeagueSandbox/leaguesandbox.github.io) + [![Build status](https://ci.appveyor.com/api/projects/status/7olahkndcs3r295p/branch/indev?svg=true)](https://ci.appveyor.com/project/MythicManiac/gameserver/branch/indev) [![Build Status](https://travis-ci.org/LeagueSandbox/GameServer.svg?branch=indev)](https://travis-ci.org/LeagueSandbox/GameServer) -Project website along with more specifications can be found from: https://leaguesandbox.github.io/ -Project chat on Discord: https://discord.gg/Bz3znAM +Project website along with more specifications can be found from: + +Project chat on Discord: + +## Install notes + +Post install you are required to set -### Install notes -Post install you are required to set - `/home/container/Settings/GameInfo.json` `CONTENT_PATH` to just `Content` - `/home/container/Settings/GameServerSettings.json` `autoStartClient` to `false` -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | | ---- | ------- | -| Game | 5119 | \ No newline at end of file +| Game | 5119 | diff --git a/game_eggs/mindustry/mindustry/README.md b/game_eggs/mindustry/README.md similarity index 87% rename from game_eggs/mindustry/mindustry/README.md rename to game_eggs/mindustry/README.md index b47636ed..0521f66a 100644 --- a/game_eggs/mindustry/mindustry/README.md +++ b/game_eggs/mindustry/README.md @@ -1,15 +1,14 @@ # Mindustry -#### About the game +## About the game Mindustry is a hybrid tower-defense sandbox factory game. Create elaborate supply chains of conveyor belts to feed ammo into your turrets, produce materials to use for building, and defend your structures from waves of enemies. Features include a map editor, 24 built-in maps, cross-platform multiplayer and large-scale PvP unit battles. - You can get it from [Steam](https://store.steampowered.com/app/1127400) +## Server Port -### Server Port -Mindustry requires a single port +Mindustry requires a single port | Port | Default | |---------|---------| diff --git a/game_eggs/mindustry/mindustry/egg-mindustry.json b/game_eggs/mindustry/egg-mindustry.json similarity index 100% rename from game_eggs/mindustry/mindustry/egg-mindustry.json rename to game_eggs/mindustry/egg-mindustry.json diff --git a/game_eggs/minecraft/README.md b/game_eggs/minecraft/README.md index cf9cef67..3de2f28e 100644 --- a/game_eggs/minecraft/README.md +++ b/game_eggs/minecraft/README.md @@ -4,43 +4,47 @@ It’s a game about placing blocks and going on adventures It’s set in infinitely-generated worlds of wide open terrain - icy mountains, swampy bayous, vast pastures and much more - filled with secrets, wonders and peril! -[Bedrock](/game_eggs/minecraft/bedrock) Servers for Bedrock Minecraft (Windows 10, mobile, console) -* [Bedrock](/game_eggs/game_eggs/minecraft/bedrock/bedrock) -* [gomint](/game_eggs/minecraft/bedrock/gomint) -* [Nukkit](/game_eggs/minecraft/bedrock/nukkit) -* [PocketMine MP](/game_eggs/minecraft/bedrock/pocketmine_mp) +## [Bedrock](bedrock) Servers for Bedrock Minecraft (Windows 10, mobile, console) -[Java](/game_eggs/minecraft/java/) Servers for Java Minecraft -* [Airplane](/game_eggs/minecraft/java/airplane) -* [Cuberite](/game_eggs/minecraft/java/cuberite) -* [Fabric](/game_eggs/minecraft/java/fabric) -* [Feather](/game_eggs/minecraft/java/feather) -* [Feed The Beast](/game_eggs/minecraft/java/ftb) -* [Forge](/game_eggs/minecraft/java/forge) +* [Bedrock](bedrock/bedrock) +* [gomint](bedrock/gomint) +* [Nukkit](bedrock/nukkit) +* [PocketMine MP](bedrock/pocketmine_mp) + +## [Java](java) Servers for Java Minecraft + +* [Airplane](minecraft/java/airplane) +* [Cuberite](minecraft/java/cuberite) +* [Fabric](minecraft/java/fabric) +* [Feather](minecraft/java/feather) +* [Forge](minecraft/java/forge) + * [Forge](minecraft/java/forge/forge) + * [CusreForge Generic](minecraft/java/forge/curseforge-generic) +* [Feed The Beast](minecraft/java/ftb) * [Krypton](/minecraft/java/krypton) -* [Magma](/game_eggs/minecraft/java/magma) -* [Mohist](/game_eggs/minecraft/java/mohist) -* [NanoLimbo](/game_eggs/minecraft/java/nanolimbo) -* [Paper](/game_eggs/minecraft/java/paper) -* [Purpur](/game_eggs/minecraft/java/purpur) -* [Spigot](/game_eggs/minecraft/java/spigot) -* [SpongeForge](/game_eggs/minecraft/java/spongeforge) -* [SpongeVanilla](/game_eggs/minecraft/java/spongevanilla) -* [Technic](/game_eggs/minecraft/java/technic) -* [Tuinity](/game_eggs/minecraft/java/tuinity) -* [VanillaCord](/game_eggs/minecraft/java/vanillacord) +* [Magma](minecraft/java/magma) +* [Mohist](minecraft/java/mohist) +* [NanoLimbo](/minecraft/java/nanolimbo) +* [Paper](minecraft/java/paper) +* [Purpur](minecraft/java/purpur) +* [Spigot](minecraft/java/spigot) +* [SpongeForge](minecraft/java/spongeforge) +* [SpongeVanilla](minecraft/java/spongevanilla) +* [Technic](minecraft/java/technic) +* [Tuinity](minecraft/java/tuinity) +* [VanillaCord](minecraft/java/vanillacord) -* [Proxies](/game_eggs/minecraft/proxy) Minecraft Server Proxies - * [Java](/game_eggs/minecraft/proxy/java) - * [FlameCord](/game_eggs/minecraft/proxy/java/flamecord) - * [Travertine](/game_eggs/minecraft/proxy/java/travertine) - * [TyphoonLimbo](/game_eggs/minecraft/proxy/java/typhoonlimbo) - * [Velocity](/game_eggs/minecraft/proxy/java/velocity) - * [VIAaaS](/game_eggs/minecraft/proxy/java/viaaas) - * [Waterfall](/game_eggs/minecraft/proxy/java/waterfall) - * [Bedrock](/game_eggs/minecraft/proxy/bedrock) - * [Waterdog PE](/game_eggs/minecraft/proxy/bedrock/waterdogpe) - * [Cross Platform](/game_eggs/minecraft/proxy/cross_platform) - * [GeyserMC](/game_eggs/minecraft/proxy/cross_platform/geyser) - * [Waterdog](/game_eggs/minecraft/proxy/cross_platform/waterdog) - * DragonProxy abandoned in favour of GeyserMC. +## [Proxies](proxy) Minecraft Server Proxies + +* [Bedrock](minecraft/proxy/bedrock) + * [Waterdog PE](minecraft/proxy/bedrock/waterdog_pe) +* [Cross Platform](minecraft/proxy/cross_platform) + * [GeyserMC](minecraft/proxy/cross_platform/geyser) + * [Waterdog](minecraft/proxy/cross_platform/waterdog) +* [Java](minecraft/proxy/java) + * [FlameCord](minecraft/proxy/java/flamecord) + * [Travertine](minecraft/proxy/java/travertine) + * [TyphoonLimbo](minecraft/proxy/java/typhoonlimbo) + * [Velocity](minecraft/proxy/java/velocity) + * [VIAaas](minecraft/proxy/java/viaaas) + * [Waterfall](minecraft/proxy/java/waterfall) diff --git a/game_eggs/minecraft/bedrock/README.md b/game_eggs/minecraft/bedrock/README.md index 7c5df3df..888a88cc 100644 --- a/game_eggs/minecraft/bedrock/README.md +++ b/game_eggs/minecraft/bedrock/README.md @@ -1,17 +1,22 @@ -# Minecraft PE (bedrock edition) +# Minecraft Bedrock (Formerly Pocket Edition) + +## [Bedrock](/game_eggs/minecraft/bedrock/bedrock) -#### Bedrock [Minecraft Bedrock Server](https://minecraft.net/en-us/download/server/bedrock/) The official Minecraft Bedrock (Formerly Minecraft Pocket Edition) server. -#### gomint +## [gomint](/game_eggs/minecraft/bedrock/gomint) + [Gomint Bedrock Server](https://github.com/gomint/gomint) -Easy-to-use, highly configurable Minecraft Bedrock Edition
 server software with the ability to sustain in a low-resource environment. +No longer actively maintained. +GoMint is a modern Minecraft Bedrock Edition server enabling you to make your visions come true -#### Nukkit -[Nukkit GitHub](https://github.com/Nukkit/Nukkit) -Nukkit is a Nuclear-Powered Server Software For Minecraft: Pocket Edition +## [Nukkit](/game_eggs/minecraft/bedrock/nukkit) -#### PocketMine MP -[PocketMine MP](https://github.com/pmmp/PocketMine-MP) -A server software for Minecraft: Bedrock Edition in PHP +[Nukkit GitHub](https://github.com/Nukkit/Nukkit) +Nukkit is a Nuclear-Powered Server Software For Minecraft: Pocket Edition + +## [PocketMine MP](/game_eggs/minecraft/bedrock/pocketmine_mp) + +[PocketMine MP](https://github.com/pmmp/PocketMine-MP) +A server software for Minecraft: Bedrock Edition in PHP diff --git a/game_eggs/minecraft/bedrock/nukkit/README.md b/game_eggs/minecraft/bedrock/nukkit/README.md index 87b26676..c38e7b83 100644 --- a/game_eggs/minecraft/bedrock/nukkit/README.md +++ b/game_eggs/minecraft/bedrock/nukkit/README.md @@ -1,8 +1,9 @@ -# Now abandoned. Please use NukkitX by Cloudburst. -[NukkitX](https://github.com/CloudburstMC/Nukkit) # Nukkit -[Nukkit GitHub](https://github.com/Nukkit/Nukkit) +[Old Nukkit GitHub](https://github.com/Nukkit/Nukkit) -Nukkit is a Nuclear-Powered Server Software For Minecraft: Pocket Edition +## Nukkit is Abandoned, uses NukkitX now +[NukkitX](https://github.com/CloudburstMC/Nukkit) + +Nukkit is a Nuclear-Powered Server Software For Minecraft: Pocket Edition diff --git a/game_eggs/minecraft/java/README.md b/game_eggs/minecraft/java/README.md index 7c0198b7..ed9f8cc2 100644 --- a/game_eggs/minecraft/java/README.md +++ b/game_eggs/minecraft/java/README.md @@ -5,106 +5,152 @@ It’s a game about placing blocks and going on adventures It’s set in infinitely-generated worlds of wide open terrain - icy mountains, swampy bayous, vast pastures and much more - filled with secrets, wonders and peril! ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. -## Cuberite -[Cuberite](https://cuberite.org) +The minecraft server requires a single port for access (default 25565) but plugins or mods may require extra ports to enabled for the server. + +## [Cuberite](cuberite) + +[Cuberite Website](https://cuberite.org) A lightweight, fast and extensible game server for Minecraft -## Fabric -[Fabric](https://fabricmc.net) +## [Fabric](fabric) + +[Fabric Website](https://fabricmc.net) Fabric is a lightweight, experimental modding toolchain for Minecraft. -## Feather -[Feather](https://github.com/feather-rs/feather) -An experimental Minecraft server implementation in Rust +## [Feather](feather) -## Forge -[Forge MC](https://files.minecraftforge.net) -This is a direct fork of the default forge service -- Has a version detection fix for "latest" +[Feather GitHub](https://github.com/feather-rs/feather) +An experimental Minecraft server implementation in Rust -[Curse Generic](https://www.curseforge.com) -A generic service to pull forge mod packs from the curseforge site. +## Forge Based -[Magma](https://magmafoundation.org) +### [Forge](forge/forge) + +[Forge MC Website](https://files.minecraftforge.net) +This is a direct fork of the default forge service + +- Has a version detection fix for "latest" + +### [CurseForge Generic](forge/curseforge-generic) + +[CurseForge Generic Website](https://www.curseforge.com) +A generic service to pull forge mod packs from the curseforge site. + +### [Magma](magma) + +[Magma Website](https://magmafoundation.org) Magma is most powerful Forge server providing you with Forge mods and Bukkit Plugins using Spigot and Paper for Performance Optimization and Stability. -[Krypton](https://github.com/KryptonMC/Krypton) +### [Krypton](krypton) + +[Krypton GitHub](https://github.com/KryptonMC/Krypton) A fast, lightweight Minecraft server written in Kotlin. -## FTB Packs -[FTB Modpacks](https://api.modpacks.ch) +### [Mohist](mohist) + +[Mohist Github](https://github.com/Mohist-Community/Mohist) +Mohist is a minecraft forge server software that implements the Paper/Spigot/Bukkit API. + +## [FTB Packs](ftb) + +[FTB Modpacks API](https://api.modpacks.ch) 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)** +### 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". - -**Method 2** + +### 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 + 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 + 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.** +Please restart the server after first launch to fix this.** -## NanoLimbo -[NanoLimbo](https://github.com/Nan1t/NanoLimbo) +## [NanoLimbo](nanolimbo) + +[NanoLimbo GitHub](https://github.com/Nan1t/NanoLimbo) A lightweight minecraft limbo server, written on Java with Netty. The main goal of the project is maximum simplicity with a minimum number of sent and processed packets. -## Spigot +## Spigot Based + A collection of spigot and forked spigot eggs. +### [Paper](paper) + [PaperMC GitHub](https://github.com/PaperMC/Paper) -High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies +High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies Currently the default on pterodactyl for many reasons. First being that you don't need to build the jar. -[Purpur](https://purpur.pl3x.net) -Purpur is a fork of Paper and Tuinity with the goal of providing new and interesting configuration options, which allow for creating a unique gameplay experience not seen anywhere else +### [Purpur](purpur) + +[Purpur Website](https://purpurmc.org/) +Purpur is a drop-in replacement for Paper servers designed for configurability, and new fun and exciting gameplay features. + +### [Spigot](spigot) + +[Spigot Website](https://www.spigotmc.org) +This is a direct fork of the default spigot service with the added benefit of being able to build the spigot jar. -[Spigot](https://www.spigotmc.org) -This is a direct fork of the default spigot service with the added benefit of being able to build the spigot jar. - (It's noted that building the jar is intensive and time consuming) -[Mohist Github](https://github.com/Mohist-Community/Mohist) -Fork of Spigot focused on performance optimizations. +### [Airplane](airplane) [Airplane Github](https://github.com/TECHNOVE/Airplane) -A stable, optimized and fast Paper fork. +A stable, optimized and well supported Paper fork. -[Tuinity GitHub](https://github.com/Spottedleaf/Tuinity) +### [Tuinity](tuinity) + +[Tuinity GitHub](https://github.com/Spottedleaf/Tuinity) Fork of Paper aimed at improving server performance at high playercounts. - ## Sponge Powered -[SpongeForge](https://www.spongepowered.org) + +### [SpongeForge](spongeforge) + +[SpongeForge Website](https://www.spongepowered.org) SpongeForge is the implementation of the Sponge API on the Minecraft Forge platform. -[SpongeVanilla](https://www.spongepowered.org) +### [SpongeVanilla](spongevanilla) + +[SpongeVanilla Website](https://www.spongepowered.org) A community-driven open source Minecraft: Java Edition modding platform. -## Technic Packs -[Hexxit](https://www.technicpack.net/modpack/hexxit) -Gear up and set forth on a campaign worthy of legend, for Hexxit has been unearthed! +## [Technic Packs](technic) -[Blightfall](https://www.technicpack.net/modpack/blightfall) -Blightfall is a combination modpack and adventure map about surviving on an alien planet. +### [Hexxit](technic/hexxit) -[Tekkit Legends](https://www.technicpack.net/modpack/tekkit-legends) +[Hexxit Modpack Page](https://www.technicpack.net/modpack/hexxit) +Gear up and set forth on a campaign worthy of legend, for Hexxit has been unearthed! + +### [Blightfall](technic/blightfall) + +[Blightfall Modpack Page](https://www.technicpack.net/modpack/blightfall) +Blightfall is a combination modpack and adventure map about surviving on an alien planet. + +### [Tekkit Legends](technic/technic-legends) + +[Tekkit Legends Modpack Page](https://www.technicpack.net/modpack/tekkit-legends) The ancient power of Tekkits past return in this legendary pack! -[Tekkit Classic](https://www.technicpack.net/modpack/tekkit.552560) -The official Tekkit Classic modpack. Build factories, automate crafting! +### [Tekkit Classic](technic/tekkit-classic) -## VanillaCord -[VanillaCord](https://github.com/ME1312/VanillaCord) -VanillaCord adds support for BungeeCord's ip-forwarding option on vanilla Minecraft servers. \ No newline at end of file +[Tekkit Classic Modpack Page](https://www.technicpack.net/modpack/tekkit.552560) +The official Tekkit Classic modpack. Build factories, automate crafting! + +## [VanillaCord](vanillacord) + +[VanillaCord GitHub](https://github.com/ME1312/VanillaCord) +VanillaCord adds support for BungeeCord's ip-forwarding option on vanilla Minecraft servers. diff --git a/game_eggs/minecraft/java/airplane/README.md b/game_eggs/minecraft/java/airplane/README.md index 04751ebf..5771f165 100644 --- a/game_eggs/minecraft/java/airplane/README.md +++ b/game_eggs/minecraft/java/airplane/README.md @@ -1,13 +1,14 @@ # Airplane -### From their [Github](https://github.com/TECHNOVE/Airplane) -A stable, optimized and fast Paper fork. +A stable, optimized, well supported Paper fork. + +[Airplane Github](https://github.com/TECHNOVE/Airplane) + +## Minimum RAM warning -### Minimum RAM warning Approximately 2048MB - -### Server Ports +## Server Ports | Port | default | |---------|---------| diff --git a/game_eggs/minecraft/java/cuberite/README.md b/game_eggs/minecraft/java/cuberite/README.md index 495a718b..f4c97196 100644 --- a/game_eggs/minecraft/java/cuberite/README.md +++ b/game_eggs/minecraft/java/cuberite/README.md @@ -2,11 +2,14 @@ A lightweight, fast and extensible game server for Minecraft -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[Cuberite Website](https://cuberite.org/) +[Cuberite GitHub](https://github.com/cuberite/cuberite) +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |----------|---------| | Game | 25565 | -| WebAdmin | 8080 | \ No newline at end of file +| WebAdmin | 8080 | diff --git a/game_eggs/minecraft/java/fabric/README.MD b/game_eggs/minecraft/java/fabric/README.MD index 745eced2..1da85717 100644 --- a/game_eggs/minecraft/java/fabric/README.MD +++ b/game_eggs/minecraft/java/fabric/README.MD @@ -2,9 +2,11 @@ Fabric is a lightweight, experimental modding toolchain for Minecraft. -## Server Ports -The fabric server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[Fabric Website](https://fabricmc.net/) +## Server Ports + +The fabric server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| diff --git a/game_eggs/minecraft/java/feather/README.md b/game_eggs/minecraft/java/feather/README.md index 927f8d84..a5d3accc 100644 --- a/game_eggs/minecraft/java/feather/README.md +++ b/game_eggs/minecraft/java/feather/README.md @@ -2,10 +2,12 @@ An experimental Minecraft server implementation written in Rust. -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[Feather GitHub](https://github.com/feather-rs/feather) +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/forge/curseforge-generic/README.md b/game_eggs/minecraft/java/forge/curseforge-generic/README.md index cc1647db..31a4eb0e 100644 --- a/game_eggs/minecraft/java/forge/curseforge-generic/README.md +++ b/game_eggs/minecraft/java/forge/curseforge-generic/README.md @@ -1,18 +1,18 @@ # Forge Generic -### This is a generic egg for curseforge modpacks +## This is a generic egg for curseforge modpacks -You will need to give it a modpack ID. The ID for BOFA mods is `375152` for example. +You will need to give it a modpack ID. The ID for BOFA mods is `375152` for example. This can be found on the modpack page in the `About Project` section in the upper right corner. -This will grab the latest release when the version is set to latest. +This will grab the latest release when the version is set to latest. It "should" grab versions of the pack based on the modpack version numbers ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/forge/forge/README.md b/game_eggs/minecraft/java/forge/forge/README.md index 634470a8..0417423e 100644 --- a/game_eggs/minecraft/java/forge/forge/README.md +++ b/game_eggs/minecraft/java/forge/forge/README.md @@ -1,15 +1,15 @@ # Forge Generic -### This is a generic egg for the forge standalone server +## This is a generic egg for the forge standalone server This will download the latest jar for a specific forge version. this has a fix for the broken 1.7.10 and 1.8.9 versions forge has ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/ftb/README.md b/game_eggs/minecraft/java/ftb/README.md index fcf4d375..8aa27f8a 100644 --- a/game_eggs/minecraft/java/ftb/README.md +++ b/game_eggs/minecraft/java/ftb/README.md @@ -1,31 +1,33 @@ -## FTB Modpacks +# 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)** +## 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". - -**Method 2** + +## 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 + 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 + 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.** +Please restart the server after first launch to fix this.** ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| | Game | 25565 | - diff --git a/game_eggs/minecraft/java/krypton/README.md b/game_eggs/minecraft/java/krypton/README.md index 217b8e3c..f45dd559 100644 --- a/game_eggs/minecraft/java/krypton/README.md +++ b/game_eggs/minecraft/java/krypton/README.md @@ -1,12 +1,16 @@ # Krypton + A fast, lightweight Minecraft server written in Kotlin +[Krypton GitHub](https://github.com/KryptonMC/Krypton) + ## Server Ports + Krypton only requires a single port to run, just like vanilla, though plugins may need extra ports. ## Notes -Please note that the server will not function correctly unless a pre-generated world is provided. +Please note that the server will not function correctly unless a pre-generated world is provided. | Port | default | |-------|---------| diff --git a/game_eggs/minecraft/java/magma/README.md b/game_eggs/minecraft/java/magma/README.md index 51847897..009ea1ca 100644 --- a/game_eggs/minecraft/java/magma/README.md +++ b/game_eggs/minecraft/java/magma/README.md @@ -2,10 +2,12 @@ Magma is most powerful Forge server providing you with Forge mods and Bukkit Plugins using Spigot and Paper for Performance Optimization and Stability. -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[Magma Website](https://magmefoundation.org/) +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/mohist/README.MD b/game_eggs/minecraft/java/mohist/README.MD index 825d5523..76f44ea4 100644 --- a/game_eggs/minecraft/java/mohist/README.MD +++ b/game_eggs/minecraft/java/mohist/README.MD @@ -1,10 +1,12 @@ # Mohist -Mohist is a Spigot fork that prioritizes performance optimizations. +Mohist is a minecraft forge server software that implements the Paper/Spigot/Bukkit API. + +[Mohist Website](https://mohistmc.com/) ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| @@ -12,9 +14,10 @@ The minecraft server requires a single port for access (default 25565) but plugi ## Server Specific -### Supported versions: +### Supported versions + - 1.16.4 series build 132+ - 1.12.x series -- 1.7.x series build 13+ +- 1.7.x series (discontinued) build 13+ -Requires changing Minecraft_Version variable on each new Minecraft version release. \ No newline at end of file +Requires changing Minecraft_Version variable on each new Minecraft version release. diff --git a/game_eggs/minecraft/java/nanolimbo/README.MD b/game_eggs/minecraft/java/nanolimbo/README.MD index 8fc18833..4e8407cb 100644 --- a/game_eggs/minecraft/java/nanolimbo/README.MD +++ b/game_eggs/minecraft/java/nanolimbo/README.MD @@ -3,10 +3,12 @@ A lightweight minecraft limbo server, written on Java with Netty. The main goal of the project is maximum simplicity with a minimum number of sent and processed packets. This limbo is empty, there are no ability to set schematic building since this is not necessary. You can send useful information in chat or BossBar. No plugins, no logs. The server is fully clear. It only able keep a lot of players while the main server is down. -## Server Ports -The nanolimbo server requires a single port for access (default 25565). +[NanoLimbo Github](https://github.com/Nan1t/NanoLimbo) +## Server Ports + +The nanolimbo server requires a single port for access (default 25565). | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/paper/README.MD b/game_eggs/minecraft/java/paper/README.MD index 87eef00a..0b39fd4a 100644 --- a/game_eggs/minecraft/java/paper/README.MD +++ b/game_eggs/minecraft/java/paper/README.MD @@ -2,10 +2,12 @@ Paper is the next generation of Minecraft server, compatible with Spigot plugins and offering uncompromising performance. -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +Check out the [Paper Website](https://papermc.io/) for more information. +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/purpur/README.md b/game_eggs/minecraft/java/purpur/README.md index 59789e93..92735500 100644 --- a/game_eggs/minecraft/java/purpur/README.md +++ b/game_eggs/minecraft/java/purpur/README.md @@ -1,13 +1,14 @@ # Purpur -Purpur is a fork of Paper and Tuinity which provides new configuration options. +Purpur is a drop-in replacement for Paper servers designed for configurability, and new fun and exciting gameplay features. -See https://github.com/pl3xgaming/purpur for additional information. +[Purpur GitHub](https://github.com/PurpurMC/Purpur) +[Purpur Website](https://purpurmc.org/) ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/spigot/README.MD b/game_eggs/minecraft/java/spigot/README.MD index 92ed0f4f..9910d5f4 100644 --- a/game_eggs/minecraft/java/spigot/README.MD +++ b/game_eggs/minecraft/java/spigot/README.MD @@ -2,9 +2,11 @@ A high performance Minecraft server implementation -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[Spigot Website](https://www.spigotmc.org/) +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| @@ -14,6 +16,6 @@ The minecraft server requires a single port for access (default 25565) but plugi Spigot was hit with a DMCA and now requires that it be built by the user. -#### This egg will build spigot for you. +### This egg will build spigot for you -You can also supply a download link to a server jar if you want. \ No newline at end of file +You can also supply a download link to a server jar if you want. diff --git a/game_eggs/minecraft/java/spongeforge/README.MD b/game_eggs/minecraft/java/spongeforge/README.MD index deedf5a3..a46e896e 100644 --- a/game_eggs/minecraft/java/spongeforge/README.MD +++ b/game_eggs/minecraft/java/spongeforge/README.MD @@ -1,10 +1,13 @@ # SpongeForge + SpongeForge is the implementation of the Sponge API on the Minecraft Forge platform. -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[SpongePowered Website](https://www.spongepowered.org/) +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/spongevanilla/README.MD b/game_eggs/minecraft/java/spongevanilla/README.MD index 611b3648..33383c50 100644 --- a/game_eggs/minecraft/java/spongevanilla/README.MD +++ b/game_eggs/minecraft/java/spongevanilla/README.MD @@ -1,10 +1,13 @@ # SpongeVanilla + A community-driven open source Minecraft: Java Edition modding platform. -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[SpongePowered Website](https://www.spongepowered.org/) +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/technic/README.md b/game_eggs/minecraft/java/technic/README.md index b00bfacf..6b1a055e 100644 --- a/game_eggs/minecraft/java/technic/README.md +++ b/game_eggs/minecraft/java/technic/README.md @@ -1,6 +1,7 @@ -## Technic Eggs +# Technic Eggs [Technic](/game_eggs/minecraft/java/technic/) + * [Attack of the B-Team](/game_eggs/minecraft/java/technic/attack-of-the-bteam/) * [Blightfall](/game_eggs/minecraft/java/technic/blightfall/) * [Hexxit](/game_eggs/minecraft/java/technic/hexxit/) diff --git a/game_eggs/minecraft/java/tuinity/README.MD b/game_eggs/minecraft/java/tuinity/README.MD index 02345900..e57fcef3 100644 --- a/game_eggs/minecraft/java/tuinity/README.MD +++ b/game_eggs/minecraft/java/tuinity/README.MD @@ -2,10 +2,12 @@ Fork of Paper aimed at improving server performance at high playercounts. -## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +[Tuinity GitHub](https://github.com/Tuinity/Tuinity) +## Server Ports + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/java/vanillacord/README.md b/game_eggs/minecraft/java/vanillacord/README.md index 03b4b2c5..e8a6ad46 100644 --- a/game_eggs/minecraft/java/vanillacord/README.md +++ b/game_eggs/minecraft/java/vanillacord/README.md @@ -4,14 +4,14 @@ A patch for vanilla servers to work with BungeeCord's ip_forward setting. This uses [ME1312's fork](https://github.com/ME1312/VanillaCord) of VanillaCord which has been updated for modern Minecraft. -## Note: +## Notes If you've set up Spigot, Paper or some other server with BungeeCord's IP forwarding you might know that you have to set online-mode to false. Due to the way that VanillaCord works this is not necessary with this Egg, you can (and should) leave online-mode as true. ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |-------|---------| -| Game | 25565 | \ No newline at end of file +| Game | 25565 | diff --git a/game_eggs/minecraft/proxy/README.md b/game_eggs/minecraft/proxy/README.md index 10ba31bf..7386363c 100644 --- a/game_eggs/minecraft/proxy/README.md +++ b/game_eggs/minecraft/proxy/README.md @@ -10,5 +10,5 @@ * [Bedrock](/game_eggs/minecraft/proxy/bedrock) * [Waterdog PE](/game_eggs/minecraft/proxy/bedrock/waterdogpe) * [Cross Platform](/game_eggs/minecraft/proxy/cross_platform) - * [GeyserMC](/game_eggs/minecraft/proxy/cross_platform/geyser) - * [Waterdog](/game_eggs/minecraft/proxy/cross_platform/waterdog) + * [GeyserMC](/game_eggs/minecraft/proxy/cross_platform/geyser) + * [Waterdog](/game_eggs/minecraft/proxy/cross_platform/waterdog) diff --git a/game_eggs/minecraft/proxy/bedrock/README.md b/game_eggs/minecraft/proxy/bedrock/README.md index 54e84395..15d8636f 100644 --- a/game_eggs/minecraft/proxy/bedrock/README.md +++ b/game_eggs/minecraft/proxy/bedrock/README.md @@ -1,5 +1,6 @@ # Mineraft Bedrock Proxies -### Waterdog PE +## Waterdog PE + [Waterdog PE](https://github.com/WaterdogPE/WaterdogPE) WaterdogPE is a brand new Minecraft: Bedrock Edition proxy software developed by the developers of the old Waterdog Proxy. diff --git a/game_eggs/minecraft/proxy/bedrock/waterdog_pe/README.md b/game_eggs/minecraft/proxy/bedrock/waterdog_pe/README.md index 44bc3a27..6ba93d12 100644 --- a/game_eggs/minecraft/proxy/bedrock/waterdog_pe/README.md +++ b/game_eggs/minecraft/proxy/bedrock/waterdog_pe/README.md @@ -1,4 +1,5 @@ # Waterdog PE + Brand new proxy server for Minecraft: Bedrock Edition ## Server Ports diff --git a/game_eggs/minecraft/proxy/cross_platform/README.md b/game_eggs/minecraft/proxy/cross_platform/README.md index 39a88343..14b20f77 100644 --- a/game_eggs/minecraft/proxy/cross_platform/README.md +++ b/game_eggs/minecraft/proxy/cross_platform/README.md @@ -1,13 +1,13 @@ # Mineraft Cross Platform Proxies -### GeyserMC +## [GeyserMC](geyser) + [GeyserMC](https://github.com/GeyserMC) A bridge/proxy allowing you to connect to Minecraft: Java Edition servers with Minecraft: Bedrock edition. +## [Waterdog](waterdog) -### Waterdog [Waterdog](https://github.com/WaterdogPE/Waterdog) Waterdog provides native support for the Minecraft Bedrock protocols along with the existing java protocols. It is capable of using the ProtocolSupport PE encapsulation protocol over TCP, or it can use the native RakNet Bedrock protocol for traditional downstream Bedrock servers such as Nukkit, Pocketmine, Bedrock Alpha Server, MiNET, and others. - diff --git a/game_eggs/minecraft/proxy/cross_platform/geyser/README.md b/game_eggs/minecraft/proxy/cross_platform/geyser/README.md index 10c01c34..8496e37b 100644 --- a/game_eggs/minecraft/proxy/cross_platform/geyser/README.md +++ b/game_eggs/minecraft/proxy/cross_platform/geyser/README.md @@ -2,5 +2,6 @@ A bridge/proxy allowing you to connect to Minecraft: Java Edition servers with Minecraft: Bedrock edition. -### Eggs +## Eggs + GeyserMC maintains their own eggs on their github: [GeyserMC pterodactyl eggs](https://github.com/GeyserMC/pterodactyl-stuff) diff --git a/game_eggs/minecraft/proxy/cross_platform/waterdog/README.md b/game_eggs/minecraft/proxy/cross_platform/waterdog/README.md index 736f820f..eab8595f 100644 --- a/game_eggs/minecraft/proxy/cross_platform/waterdog/README.md +++ b/game_eggs/minecraft/proxy/cross_platform/waterdog/README.md @@ -1,11 +1,12 @@ # Waterdog server + Waterdog provides native support for the Minecraft Bedrock protocols along with the existing java protocols. It is capable of using the ProtocolSupport PE encapsulation protocol over TCP, or it can use the native RakNet Bedrock protocol for traditional downstream Bedrock servers such as Nukkit, Pocketmine, Bedrock Alpha Server, MiNET, and others. ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. | Port | default | |----------|---------| | Java | 25565 | -| Bedrock | 19132 | \ No newline at end of file +| Bedrock | 19132 | diff --git a/game_eggs/minetest/minetest/README.md b/game_eggs/minetest/README.md similarity index 100% rename from game_eggs/minetest/minetest/README.md rename to game_eggs/minetest/README.md diff --git a/game_eggs/minetest/minetest/egg-minetest.json b/game_eggs/minetest/egg-minetest.json similarity index 100% rename from game_eggs/minetest/minetest/egg-minetest.json rename to game_eggs/minetest/egg-minetest.json diff --git a/game_eggs/openarena/openarena/README.md b/game_eggs/openarena/README.md similarity index 68% rename from game_eggs/openarena/openarena/README.md rename to game_eggs/openarena/README.md index 269abf84..23630319 100644 --- a/game_eggs/openarena/openarena/README.md +++ b/game_eggs/openarena/README.md @@ -1,12 +1,15 @@ # OpenArena -### From their [site](http://www.openarena.ws) + +## From their [site](http://www.openarena.ws) + OpenArena is a community-produced deathmatch FPS based on GPL idTech3 technology. There are many game types supported including Free For All, Capture The Flag, Domination, Overload, Harvester, and more. -### Server Ports +## Server Ports + | Port | default | |---------|---------| | Game | 27960 | -#### Mods/Plugins may require ports to be added to the server. +### Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/openarena/openarena/egg-open-arena.json b/game_eggs/openarena/egg-open-arena.json similarity index 100% rename from game_eggs/openarena/openarena/egg-open-arena.json rename to game_eggs/openarena/egg-open-arena.json diff --git a/game_eggs/openra/README.md b/game_eggs/openra/README.md index b587c97b..a87ceab0 100644 --- a/game_eggs/openra/README.md +++ b/game_eggs/openra/README.md @@ -1,5 +1,5 @@ # OpenRA Servers -OpenRA is a project that recreates and modernizes the classic Command & Conquer real time strategy games. -We have developed a flexible open source game engine (the OpenRA engine) that provides -a common platform for rebuilding and reimagining classic 2D and 2.5D RTS games (the OpenRA mods). \ No newline at end of file +OpenRA is a project that recreates and modernizes the classic Command & Conquer real time strategy games. +We have developed a flexible open source game engine (the OpenRA engine) that provides +a common platform for rebuilding and reimagining classic 2D and 2.5D RTS games (the OpenRA mods). diff --git a/game_eggs/openra/openra_dune2000/README.md b/game_eggs/openra/openra_dune2000/README.md index a89ee18e..fcf95648 100644 --- a/game_eggs/openra/openra_dune2000/README.md +++ b/game_eggs/openra/openra_dune2000/README.md @@ -1,20 +1,21 @@ # OpenRA Dune2000 -#### The classic command & conquer Server +## The classic command & conquer Server +## from the developers -#### from the developers OpenRA is a project that recreates and modernizes the classic Command & Conquer real time strategy games. We have developed a flexible open source game engine (the OpenRA engine) that provides a common platform for rebuilding and reimagining classic 2D and 2.5D RTS games (the OpenRA mods). This means that OpenRA is not restricted by the technical limitations of the original closed-source games: it includes native support for modern operating systems and screen resolutions (including Windows 10, macOS, and most Linux distros) without relying on emulation or binary hacks, and features integrated online multiplayer. Make sure to checkout their [Home Page](https://openra.net). -### Server Ports -OpenRA requires a single port +## Server Ports + +OpenRA requires a single port | Port | default | |---------|---------| | Game | 5500 | -#### Mods/Plugins may require ports to be added to the server. \ No newline at end of file +## Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/openra/openra_red_alert/README.md b/game_eggs/openra/openra_red_alert/README.md index 1ad6002d..c1ea47a1 100644 --- a/game_eggs/openra/openra_red_alert/README.md +++ b/game_eggs/openra/openra_red_alert/README.md @@ -1,20 +1,21 @@ # OpenRA -#### The classic command & conquer Server +## The classic command & conquer Server +## from the developers -#### from the developers OpenRA is a project that recreates and modernizes the classic Command & Conquer real time strategy games. We have developed a flexible open source game engine (the OpenRA engine) that provides a common platform for rebuilding and reimagining classic 2D and 2.5D RTS games (the OpenRA mods). This means that OpenRA is not restricted by the technical limitations of the original closed-source games: it includes native support for modern operating systems and screen resolutions (including Windows 10, macOS, and most Linux distros) without relying on emulation or binary hacks, and features integrated online multiplayer. Make sure to checkout their [Home Page](https://openra.net). -### Server Ports -OpenRA requires a single port +## Server Ports + +OpenRA requires a single port | Port | default | |---------|---------| | Game | 5500 | -#### Mods/Plugins may require ports to be added to the server. \ No newline at end of file +### Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/openra/openra_tiberian_dawn/README.md b/game_eggs/openra/openra_tiberian_dawn/README.md index 2ad7281c..98db384b 100644 --- a/game_eggs/openra/openra_tiberian_dawn/README.md +++ b/game_eggs/openra/openra_tiberian_dawn/README.md @@ -1,20 +1,21 @@ # OpenRA Tiberian Dawn -#### The classic command & conquer Server +## The classic command & conquer Server +## from the developers -#### from the developers OpenRA is a project that recreates and modernizes the classic Command & Conquer real time strategy games. We have developed a flexible open source game engine (the OpenRA engine) that provides a common platform for rebuilding and reimagining classic 2D and 2.5D RTS games (the OpenRA mods). This means that OpenRA is not restricted by the technical limitations of the original closed-source games: it includes native support for modern operating systems and screen resolutions (including Windows 10, macOS, and most Linux distros) without relying on emulation or binary hacks, and features integrated online multiplayer. Make sure to checkout their [Home Page](https://openra.net). -### Server Ports -OpenRA requires a single port +## Server Ports + +OpenRA requires a single port | Port | default | |---------|---------| | Game | 5500 | -#### Mods/Plugins may require ports to be added to the server. \ No newline at end of file +### Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/rdr/README.md b/game_eggs/rdr/README.md index abade62b..50e47255 100644 --- a/game_eggs/rdr/README.md +++ b/game_eggs/rdr/README.md @@ -1,6 +1,6 @@ -# Read Dead Redemption +# Read Dead Redemption ## RedM -[RedM](https://redm.gg/) -RedM, for Red Dead Redemption 2 on PC. Launching now, based on the CitizenFX framework and Cfx.re technology. \ No newline at end of file +[RedM](https://redm.gg/) +RedM, for Red Dead Redemption 2 on PC. Launching now, based on the CitizenFX framework and Cfx.re technology. diff --git a/game_eggs/rdr/redm/README.md b/game_eggs/rdr/redm/README.md index 469e3f07..8900e0bd 100644 --- a/game_eggs/rdr/redm/README.md +++ b/game_eggs/rdr/redm/README.md @@ -1,16 +1,19 @@ # Red M -### From the [RedM](https://redm.gg/) Site +## From the [RedM](https://redm.gg/) Site + RedM, for Red Dead Redemption 2 on PC. Launching now, based on the CitizenFX framework and Cfx.re technology. -### Install notes +## Install notes + - Only installs latest version versions are not selectable. -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | |---------|---------| | Game | 30120 | | ServerListing | 30110 | -| cfx join links | 30130 | \ No newline at end of file +| cfx join links | 30130 | diff --git a/game_eggs/starmade/starmade/README.md b/game_eggs/starmade/README.md similarity index 74% rename from game_eggs/starmade/starmade/README.md rename to game_eggs/starmade/README.md index 33583884..4a7bdc61 100644 --- a/game_eggs/starmade/starmade/README.md +++ b/game_eggs/starmade/README.md @@ -1,8 +1,11 @@ # Starmade Server -### From their [Homepage](https://starmadedock.net/) - [Guide](https://www.star-made.org/help/setting_up_a_server) + +## From their [Homepage](https://starmadedock.net/) - [Guide](https://www.star-made.org/help/setting_up_a_server) + The ultimate space sandbox. Participate in epic fleet battles, form alliances, strive to dominate entire galaxies and harness the universe’s resources for your industrious empire or the destruction of others. Customise your experience, the universe is yours! -### Server Ports +## Server Ports + Ports required to run the server | Port | default | diff --git a/game_eggs/starmade/starmade/egg-starmade.json b/game_eggs/starmade/egg-starmade.json similarity index 100% rename from game_eggs/starmade/starmade/egg-starmade.json rename to game_eggs/starmade/egg-starmade.json diff --git a/game_eggs/steamcmd_servers/7_days_to_die/README.md b/game_eggs/steamcmd_servers/7_days_to_die/README.md index 10d93cf6..890b3d11 100644 --- a/game_eggs/steamcmd_servers/7_days_to_die/README.md +++ b/game_eggs/steamcmd_servers/7_days_to_die/README.md @@ -1,8 +1,10 @@ # 7 Days to Die -Steam Description + +Steam Description Set in a brutally unforgiving post-apocalyptic world overrun by the undead, 7 Days to Die is an open-world game that is a unique combination of first person shooter, survival horror, tower defense, and role-playing games. It presents combat, crafting, looting, mining, exploration, and character growth, in a way that has seen a rapturous response from fans worldwide. Play the definitive zombie survival sandbox RPG that came first. Navezgane awaits! -### Server Ports +## Server Ports + 7 Days to Die requires up to 6 ports | Port | default | diff --git a/game_eggs/steamcmd_servers/README.md b/game_eggs/steamcmd_servers/README.md index 8e5ec47f..448c6b72 100644 --- a/game_eggs/steamcmd_servers/README.md +++ b/game_eggs/steamcmd_servers/README.md @@ -3,54 +3,70 @@ This is a collection of servers that use SteamCMD to install. ## 7 Days To Die + [7 Days To Die](7_days_to_die) ## ARK: Survival Evolved + [ARK: Survival Evolved](ark_survival_evolved) ## Arma - * [Arma 3](arma/arma3) + +[Arma 3](arma/arma3) ## Assetto Corsa + [Assetto Corsa](assetto_corsa) ## Avorion + [Avorion](avorion) ## Barotrauma + [Barotrauma](barotrauma) ## Citadel: Forged with Fire + [citadel](citadel) ## Conan Exiles + [Conan Exiles](conan_exiles) ## Craftopia [Craftopia](craftopia) ## CryoFall + [Cryofall](cryofall) ## Don't Starve Together + [Don't Starve Together](dont_starve) ## ECO + [ECO](eco) ## HLDS Server + [HLDS Server](hlds_server) ## Holdfast: Nations At War + [Holdfast: Nations At War](holdfast) ## Hurtworld + [Hurtworld](hurtworld) ## Insurgency: Sandstorm + [Insurgency: Sandstorm](insurgency_sandstorm) ## Killing Floor 2 + [Killing Floor 2](killing_floor_2) ## Left 4 Dead @@ -60,86 +76,113 @@ This is a collection of servers that use SteamCMD to install. [Left 4 Dead](left4dead_2) ## Modiverse + [Modiverse](modiverse) ## Mordhau + [Mordhau](mordhau) ## Onset + [Onset](onset) ## Pavlov VR + [Pavlov VR](pavlov_vr) ## PixARK + [PixARK](pixark) ## Post Scriptum + [Post Scriptum](post_scriptum) ## Project Zomboid + [Project Zomboid](project_zomboid) ## Quake Live + [Quake Live](quake_live) ## Rising World + [Rising World](rising_world) ## Risk of Rain 2 + [Risk Of Rain 2](risk_of_rain_2) ## Rust + * [Rust](rust) * [Autowipe](rust/rust_autowipe) * [Staging](rust/rust_staging) ## Satisfactory + [Satisfactory](satisfactory) ## SCP: Secret Laboratory + * [SCP: Secret Laboratory](scpsl) * [dedicated](scpsl/dedicated) * [exiled](scpsl/exiled) * [multiadmin](scpsl/multiadmin) ## Soldat + [Soldat](soldat) ## Space Engineers + [Space Engineers](space_engineers) ## Squad + [Squad](squad) ## Starbound + [Starbound](starbound) ## Stationeers + [Stationeers](stationeers) ## Stormworks: Build and Rescue + [Stormworks: Build and Rescue](stormworks) ## Subnautica: Nitrox Mod + [Subnautica: Nitrox Mod](subnautica_nitrox_mod) ## Sven coop + [Sven Co-op](svencoop) ## Team Fortress 2 Classic + [Team Fortress 2 Classic](team_fortress_2_classic) ## The Forest + [The Forest](the_forest) ## Tower Unite + [Tower Unite](tower_unite) ## Unturned + [Unturned](unturned) ## Valheim + [Valheim](valheim) - * [Valheim Vanilla](valheim/valheim_vanilla) - * [Valheim Plus Mod](valheim/valheim_plus) + +* [Valheim Vanilla](valheim/valheim_vanilla) +* [Valheim Plus Mod](valheim/valheim_plus) diff --git a/game_eggs/steamcmd_servers/ark_survival_evolved/README.md b/game_eggs/steamcmd_servers/ark_survival_evolved/README.md index f21c26fb..3df719db 100644 --- a/game_eggs/steamcmd_servers/ark_survival_evolved/README.md +++ b/game_eggs/steamcmd_servers/ark_survival_evolved/README.md @@ -9,7 +9,7 @@ As a man or woman stranded naked, freezing and starving on the shores of a myste This server requires about 4096M to run with no players on a default map. Although it is recommended to run 6144M by the ARK creators, specific DLC maps will increase this requirement, such as Genesis 2 requiring over 13,440M to start. -See the following - https://ark.gamepedia.com/Dedicated_Server_Setup#Hardware +See the following - ### RCON diff --git a/game_eggs/steamcmd_servers/arma/README.md b/game_eggs/steamcmd_servers/arma/README.md index ddc7aa90..9e667cb5 100644 --- a/game_eggs/steamcmd_servers/arma/README.md +++ b/game_eggs/steamcmd_servers/arma/README.md @@ -3,4 +3,5 @@ ARMA is a series of first-person tactical military shooters, originally released for Microsoft Windows. It features large elements of realism and simulation; a blend of large-scale military conflict spread across large areas alongside the more close quartered battles. ## Arma Titles + * [Arma 3](arma3) diff --git a/game_eggs/steamcmd_servers/arma/arma3/README.md b/game_eggs/steamcmd_servers/arma/arma3/README.md index 73aa486c..c06131db 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/README.md +++ b/game_eggs/steamcmd_servers/arma/arma3/README.md @@ -1,7 +1,10 @@ # Arma 3 + ***Updating your Egg? Please see [How to Update Egg](#how-to-update-egg) to avoid any issues!*** ___ -### Authors / Contributors + +## Authors / Contributors +
@@ -37,11 +40,15 @@ ___ ___ + ### Game Description + From Bohemia Interactive's [Website](https://arma3.com/): > Experience true combat gameplay in a massive military sandbox. Deploying a wide variety of single and multiplayer content, over 20 vehicles and 40 weapons, and limitless opportunities for content creation, this is the PC’s premier military game. Authentic, diverse, open - Arma 3 sends you to war. ___ + ### Egg Capabilities + - Configurable to run 32 or 64-bit versions of the server - Max Players is configurable and able to be host enforced (\*see [Recommended Egg Modifications](#recommended-egg-modifications)) - Able to download server updates on startup @@ -55,12 +62,18 @@ ___ - Additional [Arma 3 startup parameters](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters) can be added to fine-tune performance - Configurable to run up to 5 Headless Clients in parallel with the main server (may require additional performance overhead) - [WHMCS](https://www.whmcs.com/) compatible (\*see [Recommended Egg Modifications](#recommended-egg-modifications)) + ___ + ### Installation Requirements + - A valid, **real** Steam account, with **Steam Guard turned off**, is required to install the server (default "anonymous" login cannot be used). For security reasons it is [recommended by Valve](https://developer.valvesoftware.com/wiki/SteamCMD#With_a_Steam_account) that you create a new Steam account just for your dedicated servers. This account *does not* need to own Arma 3. - For automatic Steam Workshop mod downloading to work, the Steam account *does* need to own Arma 3. However, this is optional functionality, and mods can be manually uploaded to the server if desired. Hosts may feel free to change the "Disable Mod Downloads/Updates" variable to `1` if they would not like to offer it's functionality to clients. + ___ + ### Server Ports + Default server ports are listed below, but the Main port can be any port. There are three more ports after the Main port are relative to the Main port (For example: The BattlEye port is always 4 ports higher than the main port). **All four ports are required for normal server behavior.** It is [recommended](https://community.bistudio.com/wiki/Arma_3:_Dedicated_Server#Port_Forwarding) that each server be 100 ports separate from each other. | Port | Default | @@ -70,25 +83,41 @@ Default server ports are listed below, but the Main port can be any port. There | Steam Port (+2) | 2304 | | BattleEye (+4) | 2306 | -#### Mods/Plugins may require ports to be added to the server. +#### Mods/Plugins may require ports to be added to the server + ___ + ### CPU Usage Information + ARMA 3 is mainly CPU intensive. Contrary to popular belief, the server binary *can* run on multiple cores/threads. However, it's ability to manage asynchronous tasks and hyperthread is *very* limited, meaning additional cores/threads reach diminishing returns very quickly. In addition, it's ability to utilize all of the CPU allotted to it for AI processing seems to be limited as well. Therefore, a Headless Client ***and*** a properly written mission file are highly recommended if large amounts of AI units will be used. + ___ + ### Minimum RAM Requirement + This server requires about 2048 MB of RAM to run properly. If used, every Headless Client uses an additional 2048 MB of RAM as well. ___ + ### Minimum Disk Requirement + This server requires just under 10 GB of disk space to safely run properly with no mods. However, mods can easily increase disk usage to 50 GB or more, depending on how many are downloaded. ___ + ### Recommended Egg Modifications + The following are highly recommended variable modifications you can make to the egg after importing it to your panel. While viewing this egg, simply go to the "Variables" tab of the egg editor to make these changes. + #### Default Steam Username & Password + - To make deploying servers easy (**or if you are using WHMCS**), it is recommended to edit the default values of "Steam Username" and "Steam Password" to your Steam account dedicated for hosting. This will make all newly installed servers use these credentials. **DO NOT** make these fields visible to the end user so that they can use their own Steam accounts; the panel will save their Steam credentials in **plain text**, which is a BIG NO NO for security and privacy. + #### Restrict Max Players + - If you would like to restrict the maximum number of players that can join your client's server, you can change the permissions of the "Max Players" variable so that clients can only view this value (and not edit it). It's default value can also be changed, or the value can be changed on a server-by-server basis as desired. ___ + ### How to Update Egg + If you already have an Arma 3 egg installed on your panel, there are a couple things to consider before updating to this egg: - The Startup Command has changed, but Pterodactyl currently does not update this across all your existing servers. Servers will still boot with their old Startup Command, but the new HTML Modlist feature will not work, and depreciated variables for config files will be used. Servers will have to be manually updated to the new Startup Command via the Startup tab. - Startup Variables have been completely rehauled. While most important existing variables have retained their Environment Variable names, a lot of their titles and order have been adjusted. Simply updating your existing egg with this egg may lead to Startup Variables being terribly out of order and cluttered. Therefore, the following steps are recommended to avoid this: diff --git a/game_eggs/steamcmd_servers/barotrauma/README.md b/game_eggs/steamcmd_servers/barotrauma/README.md index 0e0f1cfa..68b2f7d1 100644 --- a/game_eggs/steamcmd_servers/barotrauma/README.md +++ b/game_eggs/steamcmd_servers/barotrauma/README.md @@ -1,9 +1,11 @@ # Barotrauma -### From their [Steam Description](https://store.steampowered.com/app/602960/Barotrauma/) + +## From their [Steam Description](https://store.steampowered.com/app/602960/Barotrauma/) + Barotrauma is a 2D co-op survival horror submarine simulator, inspired by games like FTL: Faster Than Light, Rimworld, Dwarf Fortress and Space Station 13. It’s a Sci-Fi game that combines ragdoll physics and alien sea monsters with teamwork and existential fear. +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | @@ -14,7 +16,8 @@ Ports required to run the server in a table format. **WARNING You must edit the port and server settings in serversettings.xml file or your server will not work!** -### No console +## No console + Barotrauma server does not currently have server console, it will just spam random messages. You have to add yourself as admin and type commands in-game. Admin file is located at Data/clientpermissions.xml, example config is below. ``` @@ -22,5 +25,5 @@ Barotrauma server does not currently have server console, it will just spam rand + preset="Admin" /> diff --git a/game_eggs/steamcmd_servers/citadel/README.md b/game_eggs/steamcmd_servers/citadel/README.md index e85ca5c1..63290dc2 100644 --- a/game_eggs/steamcmd_servers/citadel/README.md +++ b/game_eggs/steamcmd_servers/citadel/README.md @@ -1,4 +1,5 @@ # Citadel: Forged with fire + Citadel: Forged With Fire is a massive online sandbox RPG set in the mystical world of Ignus. Featuring magic, spellcasting, building, exploring and crafting as you fight to make a name for yourself and achieve notoriety across the land. ## Server Ports diff --git a/game_eggs/steamcmd_servers/conan_exiles/README.md b/game_eggs/steamcmd_servers/conan_exiles/README.md index 4ec44fe6..32017867 100644 --- a/game_eggs/steamcmd_servers/conan_exiles/README.md +++ b/game_eggs/steamcmd_servers/conan_exiles/README.md @@ -1,10 +1,15 @@ -### From their [Site](https://conanexiles.com/) +# Conan Exiles + +## From their [Site](https://conanexiles.com/) + Conan Exiles is online multiplayer survival game set in the lands of Conan the Barbarian -### Minimum RAM warning +## Minimum RAM warning + This server requires about 4096m to run properly. -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | @@ -12,4 +17,4 @@ Ports required to run the server in a table format. | Game | 7777 | | Steam Query | 27015 | -### More information can be found [here](https://forums.funcom.com/t/conan-exiles-dedicated-server-app-latest-version-1-0-21/21699) \ No newline at end of file +## More information can be found [here](https://forums.funcom.com/t/conan-exiles-dedicated-server-app-latest-version-1-0-21/21699) diff --git a/game_eggs/steamcmd_servers/cryofall/README.md b/game_eggs/steamcmd_servers/cryofall/README.md index 88c44a53..6565246e 100644 --- a/game_eggs/steamcmd_servers/cryofall/README.md +++ b/game_eggs/steamcmd_servers/cryofall/README.md @@ -1,13 +1,15 @@ # CryoFall -##Minimum RAM warning +## Minimum RAM warning + You may want to assign a minimum of 1GB of RAM to a server. -##Required Server Ports +## Server Ports + The default is 6000 can be changed in SettingsServer.xml | Port | default | |---------|---------| | Game | 6000 | -#### Plugins may require ports to be added to the server. +### Plugins may require ports to be added to the server diff --git a/game_eggs/steamcmd_servers/dont_starve/README.md b/game_eggs/steamcmd_servers/dont_starve/README.md index 00bb2aa1..5236e70d 100644 --- a/game_eggs/steamcmd_servers/dont_starve/README.md +++ b/game_eggs/steamcmd_servers/dont_starve/README.md @@ -1,20 +1,23 @@ # Don't Starve Together -### From their [site](https://www.klei.com/games/dont-starve) -Don’t Starve is an uncompromising wilderness survival game full of science and magic. -You play as Wilson, an intrepid Gentleman Scientist who has been trapped by a demon and transported to a mysterious wilderness world. Wilson must learn to exploit his environment and its inhabitants if he ever hopes to escape and find his way back home. +## From their [site](https://www.klei.com/games/dont-starve) + +Don’t Starve is an uncompromising wilderness survival game full of science and magic. + +You play as Wilson, an intrepid Gentleman Scientist who has been trapped by a demon and transported to a mysterious wilderness world. Wilson must learn to exploit his environment and its inhabitants if he ever hopes to escape and find his way back home. Enter a strange and unexplored world full of strange creatures, dangers, and surprises. Gather resources to craft items and structures that match your survival style. Play your way as you unravel the mysteries of this strange land. -### Minimum RAM warning +## Minimum RAM warning + Minimum required memory to run the server is around 512mb for a single user.. +## Server Ports -### Server Ports Don't Starve Together only requires a single port to run. The default is 10999 | Port | default | |---------|---------| | Game | 10999 | -#### Mods/Plugins may require ports to be added to the server. +### Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/steamcmd_servers/eco/README.md b/game_eggs/steamcmd_servers/eco/README.md index 147bda91..4ae287a2 100644 --- a/game_eggs/steamcmd_servers/eco/README.md +++ b/game_eggs/steamcmd_servers/eco/README.md @@ -1,15 +1,16 @@ # Eco -Steam Description + +Steam Description Eco is a community-based game; the players develop laws, government, and an economy to determine the success of their world. We need extensive playtesting to get the balance of our core features just right. Early Access is the perfect fit for finding an audience for this while also funding additional development. -### Server Ports +## Server Ports + Eco requires up to 2 ports game port (default 3000) web port (default 3001) - | Port | default | |---------|---------------| | Game | 3000 | -| Web | 3001 | \ No newline at end of file +| Web | 3001 | diff --git a/game_eggs/steamcmd_servers/fof/README.md b/game_eggs/steamcmd_servers/fof/README.md index 58fc0779..96e8256f 100644 --- a/game_eggs/steamcmd_servers/fof/README.md +++ b/game_eggs/steamcmd_servers/fof/README.md @@ -4,7 +4,8 @@ Multiplayer based, first person enabled, action packed and skill demanding shooter set in the Wild West times. A unique combination of non stop action and slow but powerful weaponry. -### Server Ports +## Server Ports + FOF servers require 1 port to be open, the SourceTV port can also be opened for spectators. | Port | default | diff --git a/game_eggs/steamcmd_servers/hlds_server/README.md b/game_eggs/steamcmd_servers/hlds_server/README.md index 8f65ef99..71480325 100644 --- a/game_eggs/steamcmd_servers/hlds_server/README.md +++ b/game_eggs/steamcmd_servers/hlds_server/README.md @@ -2,11 +2,12 @@ This is for older games like CS 1.6 (default game) and other servers that still run on the older HLDS server under id 90 -### Server Ports +## Server Ports + HLDS servers require up to 6 ports | Port | default | |-----------|---------| | Game/rcon | 27015 | | HLTV | 27020 | -| VAC | 26900 | \ No newline at end of file +| VAC | 26900 | diff --git a/game_eggs/steamcmd_servers/holdfast/README.md b/game_eggs/steamcmd_servers/holdfast/README.md index 73b47c7e..d49246ae 100644 --- a/game_eggs/steamcmd_servers/holdfast/README.md +++ b/game_eggs/steamcmd_servers/holdfast/README.md @@ -1,23 +1,17 @@ -# What is Holdfast: Nations At War ? +# What is Holdfast: Nations At War + Fight on multiple fronts in Holdfast: Nations At War - A competitive multiplayer first and third person shooter set during the great Napoleonic Era. Charge into battle with over 150 players per server! -> [Holdfast: NaW](https://store.steampowered.com/app/589290/Holdfast_Nations_At_War/) +>[Holdfast: NaW](https://store.steampowered.com/app/589290/Holdfast_Nations_At_War/) -logo +![image](https://steamcdn-a.akamaihd.net/steam/apps/589290/capsule_616x353.jpg?t=1600279941) -# How to import an egg in [Pterodactyl](https://pterodactyl.io/) +## Server Ports -1. Download [egg-holdfast-na-w.json](https://github.com/ankit2951/pterodactyl-holdfast/blob/main/egg-holdfast-na-w.json). -> It's easiest to right click the raw button and save as. -2. In your panel go to the Nests section in the admin part of the panel -3. Click the green Import Egg button -4. Browse to the json file you saved earlier -5. Select what nest you want to put the egg in. -> If you want a new nest you need to create it before importing the egg. -6. Restart the daemon on your node before creating a server using the new egg(s). +These are the servers required ports -server_port 20100 -steam_communications_port 8700 -steam_query_port 27000 - -# You must restart your daemon after importing an egg +| Port | default | +|----------------|---------| +| Game | 20100 | +| Query | 27000 | +| Communications | 8700 | diff --git a/game_eggs/steamcmd_servers/hurtworld/README.md b/game_eggs/steamcmd_servers/hurtworld/README.md index eb62c64e..0fbc72a6 100644 --- a/game_eggs/steamcmd_servers/hurtworld/README.md +++ b/game_eggs/steamcmd_servers/hurtworld/README.md @@ -1,10 +1,13 @@ # Hurtworld -### From their [website](http://hurtworld.com/) -### Install notes +## From their [website](http://hurtworld.com/) + +## Install notes + Due to rate limiting the console on the panel cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. -### Server Ports +## Server Ports + These are the servers required ports | Port | default | @@ -12,4 +15,4 @@ These are the servers required ports | Game | 12871 | | Query | 13871 | -#### Mods/Plugins may require ports to be added to the server. +### Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/steamcmd_servers/insurgency_sandstorm/README.md b/game_eggs/steamcmd_servers/insurgency_sandstorm/README.md index 61d81823..83fc4d38 100644 --- a/game_eggs/steamcmd_servers/insurgency_sandstorm/README.md +++ b/game_eggs/steamcmd_servers/insurgency_sandstorm/README.md @@ -1,18 +1,24 @@ # Insurgency: Sandstorm -Steam Description + +Steam Description Insurgency: Sandstorm is a team-based, tactical FPS based on lethal close quarters combat and objective-oriented multiplayer gameplay. Experience the intensity of modern combat where skill is rewarded, and teamwork wins the fight. ## GSLT Authentication + In order for your server to be able to authenticate with the stats server, you must authenticate your server through using a Steam GSLT (Game Server Login Token). To start your server with GSLT authentication add -GSLTToken=xxxxxxxxxxxxxxx to the server's command line where "xxxxxxxxxxxxxxx" is the token displayed on the Steam Game Server Account page. -See the following for additional configurations - https://support.newworldinteractive.com/support/solutions/articles/47001115510-server-admin-guide +See the following for additional configurations - ## Recommended server settings + ### Minimum Storage + This server requires about 5632M to install. + ### Minimum RAM + This server requires about 1024M to run with no players. ## Server Ports diff --git a/game_eggs/steamcmd_servers/killing_floor_2/README.md b/game_eggs/steamcmd_servers/killing_floor_2/README.md index 49c02fd1..7e5eedde 100644 --- a/game_eggs/steamcmd_servers/killing_floor_2/README.md +++ b/game_eggs/steamcmd_servers/killing_floor_2/README.md @@ -1,8 +1,11 @@ # Killing Floor 2 -### From their [Site](https://killingfloor2.com/) + +## From their [Site](https://killingfloor2.com/) + In KILLING FLOOR 2, players descend into continental Europe after it has been overrun by horrific, murderous clones called Zeds that were created by the corporation Horzine. The Zed outbreak caused by Horzine Biotech’s failed experiments has quickly spread with unstoppable momentum, paralyzing the European Union. Only a month ago, the first Zed outbreak from the original KILLING FLOOR ripped through London; now the specimen clones are everywhere. -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | @@ -10,4 +13,4 @@ Ports required to run the server in a table format. | Game Port | 7777 | | Query Port | 27015 | |Extra Ports |---------| -| Web Admin | 8080 | \ No newline at end of file +| Web Admin | 8080 | diff --git a/game_eggs/steamcmd_servers/modiverse/README.md b/game_eggs/steamcmd_servers/modiverse/README.md index f61dfa0e..30424fb1 100644 --- a/game_eggs/steamcmd_servers/modiverse/README.md +++ b/game_eggs/steamcmd_servers/modiverse/README.md @@ -2,13 +2,13 @@ Modiverse provides a sandbox environment with the ability to create and play mods such as TTT, Deathrun, FortWars, RP, and more! Use the many sandbox tools to build complex worlds with props, lights, thrusters, wheels, and much much more! -### Information +## Information + Default ServerConfiguration.json is provided to start the server, you must modify it with your own mods to customize the server. The game is currently in beta and as such the console is filled with debug spam, developers have noted that this will be removed when the game releases. ## Server Ports - | Port | default | |-------------|---------| | Game | 7777 | -| Query | 27015 | \ No newline at end of file +| Query | 27015 | diff --git a/game_eggs/steamcmd_servers/mordhau/README.md b/game_eggs/steamcmd_servers/mordhau/README.md index d67ed494..692805b0 100644 --- a/game_eggs/steamcmd_servers/mordhau/README.md +++ b/game_eggs/steamcmd_servers/mordhau/README.md @@ -1,23 +1,23 @@ # Mordhau -Steam Description + +Steam Description MORDHAU is a medieval first & third person multiplayer slasher. Enter a hectic battlefield of up to 64 players as a mercenary in a fictional, but realistic world, where you will get to experience the brutal and satisfying melee combat that will have you always coming back for more. -### Versions +## Versions + +### Vanilla -#### Vanilla A standard linux mordhau server -#### Wine -The windows version of the server running in Wine. -This supports some mods that do not work with the linux version of the server. +### Wine + +The windows version of the server running in Wine. +This supports some mods that do not work with the linux version of the server. Uses more resources for the server than the linux version. -### Server Ports -Mordhau requires 3 ports +## Server Ports -game port (default 7777) -query port (default 27015) -Beacon (default 15000) +Mordhau requires 3 ports | Port | default | |---------|---------------| @@ -25,11 +25,13 @@ Beacon (default 15000) | Query | 27015 | | Beacon | 15000 | -### Map Rotation / Change Config +## Map Rotation / Change Config + Lots of good information in this [thread](https://mordhau.com/forum/topic/10348/dedicated-server-hosting-guide-linux/?page=1) You'll need to run the server once before the Mordhau/Saved/Config/LinuxServer folder is available -### Default Map Variable +## Default Map Variable + By default the game always starts the same game map and mode. Change this variable to start the server wth your choice of map and mode. For example , Grad/HRD_Grad OR TaigaMap/FL_Taiga Map Types diff --git a/game_eggs/steamcmd_servers/nmrih/README.md b/game_eggs/steamcmd_servers/nmrih/README.md index 14a0589c..1d12d382 100644 --- a/game_eggs/steamcmd_servers/nmrih/README.md +++ b/game_eggs/steamcmd_servers/nmrih/README.md @@ -1,10 +1,11 @@ -# No More Room in Hell +# No More Room in Hell ## From their [Website](https://www.nomoreroominhell.com/) No More Room in Hell is the ultimate ruthless and unforgiving co-operative zombie survival experience on the Source Engine, delivering award winning survival horror gameplay with dozens of weapons and multiple game modes. -### Server Ports +## Server Ports + NMRIH servers require 1 port to be open, the SourceTV port can also be opened for spectators. | Port | default | @@ -13,4 +14,3 @@ NMRIH servers require 1 port to be open, the SourceTV port can also be opened fo | SourceTV | 27020 | ## Steam Download [SteamStore](https://store.steampowered.com/app/224260/No_More_Room_in_Hell/) - diff --git a/game_eggs/steamcmd_servers/onset/README.md b/game_eggs/steamcmd_servers/onset/README.md index 274faf9e..bdd740a9 100644 --- a/game_eggs/steamcmd_servers/onset/README.md +++ b/game_eggs/steamcmd_servers/onset/README.md @@ -1,14 +1,18 @@ # Onset -From their [site](https://playonset.com/): -Onset is an open world multiplayer sandbox without predefined goals. Create and host your very own experience in Onset using scripting functions. Whether that is Roleplay, Cops and Robbers or classic Freeroam. Or just enjoy the different gamemodes created by other players. + +From their [site](https://playonset.com/): +Onset is an open world multiplayer sandbox without predefined goals. Create and host your very own experience in Onset using scripting functions. Whether that is Roleplay, Cops and Robbers or classic Freeroam. Or just enjoy the different gamemodes created by other players. ## Recommended server settings + ### RAM + This server requires about 100M to run. -See the following - https://dev.playonset.com/wiki/DedicatedServer#Minimum_requirements_2 +See the following - ### Disk + This server uses about 50M of disk. ## Server Ports @@ -17,4 +21,4 @@ This server uses about 50M of disk. |-------|---------| | Game | 7777 | | Query | 7776 | -| file | 7775 | \ No newline at end of file +| file | 7775 | diff --git a/game_eggs/steamcmd_servers/pavlov_vr/README.md b/game_eggs/steamcmd_servers/pavlov_vr/README.md index 9c475577..b8730b09 100644 --- a/game_eggs/steamcmd_servers/pavlov_vr/README.md +++ b/game_eggs/steamcmd_servers/pavlov_vr/README.md @@ -1,22 +1,29 @@ # Pavlov VR + Pavlov VR is a multiplayer shooter in VR with heavy focus on community features. Realistic reloading features and fast paced combat as part of the core experience. ## Recommended server settings + ### Minimum RAM + This server requires about 2048M to run. A 3.2 GHz core will support approximately 24 players. Since Pavlov VR is single threaded, faster clockspeeds will mean higher performance. ### Tickrate + For stable results, please use a minimum of 50 and a maximum of 120. ### Multiple Servers on the same host -If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open. -For additional help, please see the following - http://wiki.pavlov-vr.com/index.php?title=Dedicated_server +If you are running multiple servers and have set additional ports (see ) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open. + +For additional help, please see the following - ### Steam Workshop + When downloading a large map from the steam workshop make sure your node has enough RAM assigned to store the map files in its tmpfs! This requires you to modify your wings configuration to have the tmpfs_size value increased. ## Server Ports + | Port | default | |-------|---------| | Game | 7777 | diff --git a/game_eggs/steamcmd_servers/pixark/README.md b/game_eggs/steamcmd_servers/pixark/README.md index 1183417c..7c0999b4 100644 --- a/game_eggs/steamcmd_servers/pixark/README.md +++ b/game_eggs/steamcmd_servers/pixark/README.md @@ -2,7 +2,8 @@ Welcome to PixARK, a vast, wild world filled with vicious dinosaurs, magical creatures and endless adventure! To survive in this mysterious land, you must tame creatures both ferocious and cuddly, craft high tech and magical tools, and build your own base out of cubes. -### Server Ports +## Server Ports + PixARK requires 4 ports | Port | default | @@ -10,4 +11,4 @@ PixARK requires 4 ports | Game | 27015 | | Query | 27016 | | RCON | 27017 | -| cube | 27018 | \ No newline at end of file +| cube | 27018 | diff --git a/game_eggs/steamcmd_servers/post_scriptum/README.md b/game_eggs/steamcmd_servers/post_scriptum/README.md index 7c963a86..18b93f39 100644 --- a/game_eggs/steamcmd_servers/post_scriptum/README.md +++ b/game_eggs/steamcmd_servers/post_scriptum/README.md @@ -6,9 +6,8 @@ Post Scriptum is a WW2-themed first-person tactical shooter that provides an aut Post Scriptum requires Game and Query port to function, while RCON port is only required if you want to use RCON. - -| Port | default | -|-------------|---------| -| Game | 10027 | -| Query | 10037 | -| RCON (optional) | 21114 | +| Port | default | +|-----------------|---------| +| Game | 10027 | +| Query | 10037 | +| RCON (optional) | 21114 | diff --git a/game_eggs/steamcmd_servers/project_zomboid/README.md b/game_eggs/steamcmd_servers/project_zomboid/README.md index 9a6c9389..6f6f9c32 100644 --- a/game_eggs/steamcmd_servers/project_zomboid/README.md +++ b/game_eggs/steamcmd_servers/project_zomboid/README.md @@ -7,7 +7,8 @@ Project Zomboid is the ultimate in zombie survival. Alone or in MP: you loot, bu Project Zomboid requires one port for Steam and an additional **one port per player**. Additional ports are allocated as they connect. For example, when configured with a base allocation of 27016: -``` + +```log Zomboid Steam Server started, ports 27016 and 27016 must be open on the router Connected new client kubi ID # 0 and assigned DL port 27017 Connected new client kubi2 ID # 1 and assigned DL port 27018 diff --git a/game_eggs/steamcmd_servers/quake_live/README.md b/game_eggs/steamcmd_servers/quake_live/README.md index dba53fb5..e665d67e 100644 --- a/game_eggs/steamcmd_servers/quake_live/README.md +++ b/game_eggs/steamcmd_servers/quake_live/README.md @@ -1,13 +1,15 @@ # Quake Live -A first-person shooter video game by id Software. It is an updated version of Quake III Arena that was originally designed -as a free-to-play game launched via a web browser plug-in. On September 17, 2014, the game was re-launched as a standalone + +A first-person shooter video game by id Software. It is an updated version of Quake III Arena that was originally designed +as a free-to-play game launched via a web browser plug-in. On September 17, 2014, the game was re-launched as a standalone title on Steam. -Quake Live was previously a free-to-play game, with subscription options offering additional arenas, game types and game -server options. As of October 27, 2015, the game is no longer free and must be purchased, and the subscription options +Quake Live was previously a free-to-play game, with subscription options offering additional arenas, game types and game +server options. As of October 27, 2015, the game is no longer free and must be purchased, and the subscription options were dropped. -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | diff --git a/game_eggs/steamcmd_servers/rising_world/README.md b/game_eggs/steamcmd_servers/rising_world/README.md index c2800974..f30a88ca 100644 --- a/game_eggs/steamcmd_servers/rising_world/README.md +++ b/game_eggs/steamcmd_servers/rising_world/README.md @@ -1,10 +1,13 @@ # Rising World + Rising World is a voxel based open-world sandbox game, featuring a procedurally generated world, playable in single and multi-player. -### Server Ports +## Server Ports + Rising World requires up to 7 ports. - * The RCON port is optional, but is enabled by default. - * Game ports require both TCP and UDP + +* The RCON port is optional, but is enabled by default. +* Game ports require both TCP and UDP | Port | default | |---------|---------------| diff --git a/game_eggs/steamcmd_servers/risk_of_rain_2/README.md b/game_eggs/steamcmd_servers/risk_of_rain_2/README.md index b8150b97..f14ec862 100644 --- a/game_eggs/steamcmd_servers/risk_of_rain_2/README.md +++ b/game_eggs/steamcmd_servers/risk_of_rain_2/README.md @@ -3,6 +3,7 @@ Escape a chaotic alien planet by fighting through hordes of frenzied monsters – with your friends, or on your own. ## Minimum Specifications + - At least 1GB RAM - Minimum 4GB hard disk space diff --git a/game_eggs/steamcmd_servers/rust/rust_autowipe/README.md b/game_eggs/steamcmd_servers/rust/rust_autowipe/README.md index 292eef0c..d2e8763b 100644 --- a/game_eggs/steamcmd_servers/rust/rust_autowipe/README.md +++ b/game_eggs/steamcmd_servers/rust/rust_autowipe/README.md @@ -1,4 +1,5 @@ -### Rust Autowipe +# Rust Autowipe + The only aim in Rust is to survive. To do this you will need to overcome struggles such as hunger, thirst and cold. Build a fire. Build a shelter. Kill animals for meat. Protect yourself from other players, and kill them for meat. Create alliances with other players and form a town. Do whatever it takes to survive. Adds variables to wipe files based on a list you set. Reinstall to perform the wipe. @@ -7,11 +8,13 @@ The variable `REGEN_SERVER` was added, default 0, set to 1 to generate a random Files listed in the `REMOVE_FILES` variabe, space separated, will be removed. -### Minimum RAM warning +## Minimum RAM warning + The server requires at least 4096MB to run properly. This is mostly needed for the startup only, once it is running (depending on your world size) it should consume less. -### Server Ports +## Server Ports + Ports required to run the server. | Port | default | diff --git a/game_eggs/steamcmd_servers/rust/rust_staging/README.md b/game_eggs/steamcmd_servers/rust/rust_staging/README.md index 7b577286..f1742a66 100644 --- a/game_eggs/steamcmd_servers/rust/rust_staging/README.md +++ b/game_eggs/steamcmd_servers/rust/rust_staging/README.md @@ -1,18 +1,22 @@ -### Rust Staging Branch +# Rust Staging Branch + The only aim in Rust is to survive. To do this you will need to overcome struggles such as hunger, thirst and cold. Build a fire. Build a shelter. Kill animals for meat. Protect yourself from other players, and kill them for meat. Create alliances with other players and form a town. Do whatever it takes to survive. -### Minimum RAM warning +## Minimum RAM warning + The server requires at least 4096MB to run properly. This is mostly needed for the startup only, once it is running (depending on your world size) it should consume less. -### Modding warning +## Modding warning + Due to Oxide/uMod not supporting the staging branch, you will not be able to Mod this server. Wulf (Community Admin on Oxidemod/uMod): "We only release builds for the release/public branch of Rust, so if you'd like to use it on any other branch, you'd need to manually patch it yourself using our patcher tool founder under the Snapshots repo. To switch a different Rust branch, just use the -beta tag with SteamCMD and the branch name." -### Server Ports +## Server Ports + Ports required to run the server. | Port | default | diff --git a/game_eggs/steamcmd_servers/satisfactory/README.md b/game_eggs/steamcmd_servers/satisfactory/README.md index eb260cd1..79b49fed 100644 --- a/game_eggs/steamcmd_servers/satisfactory/README.md +++ b/game_eggs/steamcmd_servers/satisfactory/README.md @@ -1,7 +1,10 @@ # Satisfactory + ***Updating your Egg?**: Ensure any existing servers have the latest Startup Command, new Startup Variables are set, **and you reinstall server!*** ___ -### Authors / Contributors + +## Authors / Contributors +
@@ -59,19 +62,27 @@ ___ ___ + ### Game Description + From Coffee Stain's [Website](https://www.satisfactorygame.com/): > Satisfactory is a first-person open-world factory building game with a dash of exploration and combat. Play alone or with friends, explore an alien planet, create multi-story factories, and enter conveyor belt heaven! + ___ + ### Egg Capabilities + - Configuration of the Server Query, Beacon, and Game ports. - Configurable to automatically check for server updates on start via SteamCMD. Forcing validation is also configurable. - *[Experimental]* Max player configuration. - Autosave amount and interval configuration. - Disable crash reporting if desired. - ...and other advanced networking and server branch configurable settings. + ___ + ### Server Ports + - Default server ports are listed below, but all three ports can be changed freely. - **Note:** The Primary/Default/Game Port for your server in Pterodactyl will be Satisfactory's `-Port=????` game port, even though clients will **connect with the Query port**. - It is recommended to distance ports of other running Satisfactory servers in Pterodactyl by **increments of 100** (it is currently unknown what the minimum increment is, but an increment of +1 caused cross-server talk in testing). Also, your internal ports **must match** your external ports on your network (ie. you can't have an external port of 7778 forwarded to your 7777 internal port; they must match). @@ -84,6 +95,7 @@ ___ | Server Query | 15777 | ___ + ### Installation/System Requirements | | Bare Minimum | Recommended | @@ -96,40 +108,54 @@ ___ | Game Ownership | Not required to start. | Required to fully "initialize" (see [Server Initialization](#server-initialization) below) | ___ + ### Server Initialization + For a server to be fully "initialized", a client who owns the game must log into the server to "claim" it and create an administrator password. Then, a new session can be created via the "Create Game" tab in-game, or an existing save file can be uploaded (see [Save Files](#save-files) below). Misc. settings listed below can be configured by an admin client via the game's "Server Settings" tab, and are currently **not** set via the Egg: + - Server Password - Admin Password - Auto-Save on Player Disconnect - Pause When No Players Online - ...and possibly more as the client's UI is developed further for more configuration options. + ___ + ### Save Files + An existing save file (including single-player saves) can currently be uploaded to the server via two different methods: - "Manage Saves" tab via a client in-game (Recommended) - Manually via the File Manager or SFTP Save files are located in this directory: -``` + +```md /home/container/.config/Epic/FactoryGame/Saved/SaveGames/server ``` + *Note: A manually uploaded save will only load if it is (a.) loaded manually via the "Manage Saves" tab in-game, (b.) it is the only save file present, or (c.) its existing session name (not its file name) matches the existing save's session name *and* has the most recent time stamp.* ***Warning:*** Stopping the server **does not** currently save your game! Ensure it is saved before stopping the server. If you have forgotten your administrator password or would generally like to reset your server as if it were new, you can delete the following file: -``` + +```md /home/container/.config/Epic/FactoryGame/Saved/SaveGames/ServerSettings. ``` + ___ + ### Console Commands + As of v0.5.1.2, the console tab in the client server manager is the only way to execute commands. Entering commands via Pterodactyl do nothing. [List of known commands can be found via the Wiki.](https://satisfactory.fandom.com/wiki/Dedicated_servers#Console_commands) ___ + ### Errors/Warnings + The following errors or warnings you see in the console can safely be ignored: ```log @@ -137,24 +163,29 @@ steamclient.so: cannot open shared object file: No such file or directory [S_API] SteamAPI_Init(): Loaded '/home/container/.steam/sdk64/steamclient.so' OK. (First tried local 'steamclient.so') LogSteamShared: Warning: Steam Dedicated Server API failed to initialize. ``` -↑ The local file of 'steamclient.so' was attempted to be loaded, but could not because it is not present, causing the warning message. However, the backup `/home/container/.steam/sdk64/steamclient.so` is loaded successfully (this is the correct behavior according to the [Wiki](https://satisfactory.fandom.com/wiki/Dedicated_servers#SteamAPI_Init.28.29:_Sys_LoadModule_filed_to_load:_.2Fpath.2Fto.2F.steam.2Fsdk64.2Fsteamclient.so)). + +The local file of 'steamclient.so' was attempted to be loaded, but could not because it is not present, causing the warning message. However, the backup `/home/container/.steam/sdk64/steamclient.so` is loaded successfully (this is the correct behavior according to the [Wiki](https://satisfactory.fandom.com/wiki/Dedicated_servers#SteamAPI_Init.28.29:_Sys_LoadModule_filed_to_load:_.2Fpath.2Fto.2F.steam.2Fsdk64.2Fsteamclient.so)). ```log Warning: failed to init SDL thread priority manager: SDL not found ``` -↑ This is a common error with Steam related software on Linux, but can safely be ignored. +This is a common error with Steam related software on Linux, but can safely be ignored. ```log ...Error: Couldn't find file for package... ``` + ```log ...Error: Navmesh bounds are too large!... ``` + ```log ...Warning: NiagaraSystem... ``` + ```log LogStreaming: Warning: Failed to read file '../../../FactoryGame/Saved/SaveGames/GameAnalytics.sav' error. ``` -↑ These seem to be common error messages with the current experimental version of the game. + +These seem to be common error messages with the current experimental version of the game. diff --git a/game_eggs/steamcmd_servers/scpsl/README.md b/game_eggs/steamcmd_servers/scpsl/README.md index b908d1a2..9c00ef3a 100644 --- a/game_eggs/steamcmd_servers/scpsl/README.md +++ b/game_eggs/steamcmd_servers/scpsl/README.md @@ -1,32 +1,38 @@ -## SCP: Secret Laboratory +# SCP: Secret Laboratory + +## [dedicated](dedicated/) -### [dedicated](dedicated/) SCP: Secret Laboratory Dedicated Linux Server AddID: [996560](https://steamdb.info/app/996560/) This Server is NOT compatible with ServerMod2 or MultiAdmin -### [MultiAdmin](multiadmin) +## [MultiAdmin](multiadmin) + SCP: Secret Laboratory Pterodactyl egg. Works with MP2. Steam AppID: [996560](https://steamdb.info/app/996560/) This server is **NOT** compatible with SMod2 due to it not being updated for MP2. This server is **NOT** compatible with LocalAdmin due to server input causing it to crash. MultiAdmin with a config option is used instead. -### [Exiled Plugin Framework](exiled) -SCP: Secret Laboratory Pterodactyl egg with Exiled Plugin Framework (https://github.com/Exiled-Team/EXILED) +## [Exiled Plugin Framework](exiled) + +SCP: Secret Laboratory Pterodactyl egg with Exiled Plugin Framework + +## Minimum RAM -### Minimum RAM Minimum memory required to run the server: 3096 MB -### Server Port +## Server Port + Default port required to run the server. | Port | Default | |---------|---------| | Game | 7777 | -### Verification +## Verification The server must be verified with the SCP:SL developers in order for it to be visible in the server browser. Instructions are as follows: + * Make sure your server complies with the [Verified Server Rules](https://scpslgame.com/Verified_server_rules.pdf). * Send an email to `server.verification@scpslgame.com` from your configured contact email with the following information: 1. The **public** IPv4 address of your server, with port. e.g. `69.69.69.69:7777` diff --git a/game_eggs/steamcmd_servers/scpsl/dedicated/README.md b/game_eggs/steamcmd_servers/scpsl/dedicated/README.md index 60411e1b..8441932a 100644 --- a/game_eggs/steamcmd_servers/scpsl/dedicated/README.md +++ b/game_eggs/steamcmd_servers/scpsl/dedicated/README.md @@ -1,31 +1,33 @@ # SCP: Secret Laboratory + SCP: Secret Laboratory Dedicated Linux Server AddID: [996560](https://steamdb.info/app/996560/) This Server is NOT compatible with ServerMod2 or MultiAdmin +## Minimum RAM warning -### Minimum RAM warning Minimum required memory to run the server: 3096 MB +## Server Ports -### Server Ports Ports required to run the server in a table format. | Port | default | |---------|---------| | Game | 7777 | -### Verification +### Mods/Plugins may require additional ports to be added to the server + +## Verification The server must be verified to be visible in the Server Browser. Before requesting verification make sure your server follows the [Verified Server Rules](https://scpslgame.com/Verified_server_rules.pdf). -#### Requesting Verification +### Requesting Verification + Once ready send an email to server.verification@scpslgame.com with the following info: * The server's external IPv4 address * The port used by the server * If the server IP is static or dynamic - -#### Mods/Plugins may require ports to be added to the server. diff --git a/game_eggs/steamcmd_servers/scpsl/exiled/README.md b/game_eggs/steamcmd_servers/scpsl/exiled/README.md index 37b488a0..68a47db1 100644 --- a/game_eggs/steamcmd_servers/scpsl/exiled/README.md +++ b/game_eggs/steamcmd_servers/scpsl/exiled/README.md @@ -1,23 +1,25 @@ # SCP: Secret Laboratory Exiled -SCP: Secret Laboratory Pterodactyl egg with Exiled Plugin Framework (https://github.com/Exiled-Team/EXILED) -### Minimum RAM +SCP: Secret Laboratory Pterodactyl egg with Exiled Plugin Framework + +## Minimum RAM + Minimum memory required to run the server: 4096 MB +## Server Port -### Server Port Default port required to run the server. | Port | Default | |---------|---------| | Game | 7777 | - -### Verification +## Verification The server must be verified with the SCP:SL developers in order for it to be visible in the server browser. Instructions are as follows: + * Make sure your server complies with the [Verified Server Rules](https://scpslgame.com/Verified_server_rules.pdf). * Send an email to `server.verification@scpslgame.com` from your configured contact email with the following information: 1. The **public** IPv4 address of your server, with port. e.g. `69.69.69.69:7777` diff --git a/game_eggs/steamcmd_servers/scpsl/multiadmin/README.md b/game_eggs/steamcmd_servers/scpsl/multiadmin/README.md index 52e05da4..1ecf654b 100644 --- a/game_eggs/steamcmd_servers/scpsl/multiadmin/README.md +++ b/game_eggs/steamcmd_servers/scpsl/multiadmin/README.md @@ -1,28 +1,29 @@ # SCP: Secret Laboratory + SCP: Secret Laboratory Pterodactyl egg. Works with MP2. Steam AppID: [996560](https://steamdb.info/app/996560/) This server is **NOT** compatible with SMod2 due to it not being updated for MP2. This server is **NOT** compatible with LocalAdmin due to server input causing it to crash. MultiAdmin with a config option is used instead. +## Minimum RAM -### Minimum RAM Minimum memory required to run the server: 3096 MB +## Server Port -### Server Port Default port required to run the server. | Port | Default | |---------|---------| | Game | 7777 | - -### Verification +## Verification The server must be verified with the SCP:SL developers in order for it to be visible in the server browser. Instructions are as follows: + * Make sure your server complies with the [Verified Server Rules](https://scpslgame.com/Verified_server_rules.pdf). * Send an email to `server.verification@scpslgame.com` from your configured contact email with the following information: 1. The **public** IPv4 address of your server, with port. e.g. `69.69.69.69:7777` diff --git a/game_eggs/steamcmd_servers/soldat/README.md b/game_eggs/steamcmd_servers/soldat/README.md index d1fc670e..23f2e904 100644 --- a/game_eggs/steamcmd_servers/soldat/README.md +++ b/game_eggs/steamcmd_servers/soldat/README.md @@ -1,4 +1,5 @@ # Soldat + Soldat is a unique 2D (side-view) multiplayer action game. It has been influenced by the best of games such as Liero, Worms, Quake, and Counter-Strike and provides a fast-paced gaming experience with tons of blood and flesh. Soldiers fight against each other in 2D battle arenas using a deadly arsenal of military weapons, across 7 default game modes. It features 18 different weapons and 60 maps to frag away on, with full support for user created content. ## Server Ports diff --git a/game_eggs/steamcmd_servers/space_engineers/README.md b/game_eggs/steamcmd_servers/space_engineers/README.md index 61ebb364..6994bec6 100644 --- a/game_eggs/steamcmd_servers/space_engineers/README.md +++ b/game_eggs/steamcmd_servers/space_engineers/README.md @@ -1,5 +1,6 @@ # Space Engineers -Space Engineers is a voxel-based sandbox game set in space and on planets. + +Space Engineers is a voxel-based sandbox game set in space and on planets. Many parts of this egg are based on the work of [mmmaxwwwell](https://github.com/mmmaxwwwell/space-engineers-dedicated-docker-linux). A thank you therefore goes to him. @@ -10,12 +11,15 @@ When installed, the Server loads a base World and config from this repo. New wor Everything which is not defined in a variable could be edited directy in the config file /config/SpaceEngineers-Dedicated.cfg. ## Minumum server settings + ### RAM + This server requires about 6GB. Based on the information provided by the developer: [See here](https://www.spaceengineersgame.com/dedicated-servers/) ### Disk + This server uses about 7GB of diskspace. ## Server Ports diff --git a/game_eggs/steamcmd_servers/squad/README.md b/game_eggs/steamcmd_servers/squad/README.md index d4db334a..ad310143 100644 --- a/game_eggs/steamcmd_servers/squad/README.md +++ b/game_eggs/steamcmd_servers/squad/README.md @@ -2,7 +2,8 @@ Squad is an online multiplayer first-person shooter that aims to capture combat realism through communication and teamplay. -### Server Ports +## Server Ports + Squad requires 4 ports | Port | default | @@ -10,4 +11,4 @@ Squad requires 4 ports | Game | 7787 | | game +1 | 7788 | | Query | 27165 | -| Query +1 | 27166 | \ No newline at end of file +| Query +1 | 27166 | diff --git a/game_eggs/steamcmd_servers/starbound/README.md b/game_eggs/steamcmd_servers/starbound/README.md index 4329884b..d47f5969 100644 --- a/game_eggs/steamcmd_servers/starbound/README.md +++ b/game_eggs/steamcmd_servers/starbound/README.md @@ -1,12 +1,12 @@ # Starbound -Their desctiption: + +Their desctiption: In Starbound, you create your own story - there’s no wrong way to play! You may choose to save the universe from the forces that destroyed your home, uncovering greater galactic mysteries in the process, or you may wish to forego a heroic journey entirely in favor of colonizing uncharted planets. -### Server Ports -Starbound requires a single port to be oepened +## Server Ports -game ports (default 21025 ) +Starbound requires a single port to be oepened | Port | default | |---------|---------| -| Game | 21025 | \ No newline at end of file +| Game | 21025 | diff --git a/game_eggs/steamcmd_servers/stationeers/README.md b/game_eggs/steamcmd_servers/stationeers/README.md index 63aefa53..a0e9bc73 100644 --- a/game_eggs/steamcmd_servers/stationeers/README.md +++ b/game_eggs/steamcmd_servers/stationeers/README.md @@ -1,15 +1,13 @@ # Stationeers -Steam Description + +Steam Description Construct and manage your own space station either by yourself in singleplayer or with friends online! Fully functioning atmospherics, science, power, engineering, medical, logic, and agricultural systems. Explore to find asteroids and construct elaborate factories to harvest your resources! -### Server Ports +## Server Ports + Stationeers requires up to 2 ports -game port (default 27500) -Steam Query Ports (default 27015) - - -| Port | default | -|---------|---------------| -| Game | 27500 | -| Query | 27015 | \ No newline at end of file +| Port | default | +|-------------|---------| +| Game | 27500 | +| Steam Query | 27015 | diff --git a/game_eggs/steamcmd_servers/stormworks/README.md b/game_eggs/steamcmd_servers/stormworks/README.md index 6a0d5354..08ce0833 100644 --- a/game_eggs/steamcmd_servers/stormworks/README.md +++ b/game_eggs/steamcmd_servers/stormworks/README.md @@ -1,19 +1,23 @@ -### Stormworks: Build and Rescue +# Stormworks: Build and Rescue + Join a world where you design, create and pilot your own air sea rescue service. Release your inner hero as you battle fierce storms out at sea to rescue those in need. -### Configuration warning +## Configuration warning + Due to the way the Stormworks configuration file is formatted and the way Pterodactyl handles config file replacement this egg cannot be configured by Pterodactyl. A config file is created in the container home directory (`/home/container/server_config.xml`) and must be manually updated for any changes, **INCLUDING THE PORT NUMBER**. This egg will not work after installation and you **MUST** edit the `server_config.xml` file manually to use anything other than the default settings. For more information about the configuration file issue see the [Github issue](https://github.com/parkervcp/eggs/issues/522#issuecomment-652514654). -### Server Ports +## Server Ports + Stormworks requires 3 consecutive ports in order to run. The default ports are shown below. Using non-default ports is possible however they must remain consecutive. -| Port | default | -|---------|---------| -| Game | 25564 | -| Game | 25565 | -| Game | 25566 | +| Port | default | +|------|---------| +| Game | 25564 | +| Game | 25565 | +| Game | 25566 | + +## Console output -### Console output The Stormworks server will constantly output updates to the server console when run under Wine. Natively this results in text that updates in place, however there is no way to disable or limit the frequency of this output. A [feature request](http://mcro.org/issues/view_issue/21739) was filed with the developer in hopes of improving the Linux support however it was rejected without comment. At this time there is no known solution. diff --git a/game_eggs/steamcmd_servers/subnautica_nitrox_mod/README.md b/game_eggs/steamcmd_servers/subnautica_nitrox_mod/README.md index e780fdf0..83381f39 100644 --- a/game_eggs/steamcmd_servers/subnautica_nitrox_mod/README.md +++ b/game_eggs/steamcmd_servers/subnautica_nitrox_mod/README.md @@ -1,25 +1,25 @@ -## Subnautica: Nitrox Mod +# Subnautica: Nitrox Mod + Subnautica is an open world survival action-adventure video game developed and published by Unknown Worlds Entertainment. In it, players are free to explore the ocean on an alien planet, known as planet 4546B, after their spaceship, the Aurora, crashes on the planet's surface. The multiplayer function is provided by the mod "Nitrox". This mod is still in alpha version and therefore not yet fully stable. - +## NOTE -**NOTE** To download the base game, you will need to authenticate against Steam. Because of the normally active Steamgaurd protection, it is important to enter the Steamgaurd code. Once the initial installation is complete, you will need to enter the Steamguard code that will be emailed to you and then reinstall the server. This will only work if you receive Steamguard codes via mail. The Authenticator app is not supported. -**NOTE** +## NOTE 2 + NitroxMod version >=1.5.0.0 is required for this egg ## Server Ports + The nitrox server requires only the default Server port. - -| Port | default | -|---------|---------| -| Server | any | - +| Port | default | +|--------|---------| +| Server | any | diff --git a/game_eggs/steamcmd_servers/svencoop/README.md b/game_eggs/steamcmd_servers/svencoop/README.md index af43edf9..f76e91ea 100644 --- a/game_eggs/steamcmd_servers/svencoop/README.md +++ b/game_eggs/steamcmd_servers/svencoop/README.md @@ -1,7 +1,9 @@ # Sven Co-op + Sven Co-op is a co-operative game originally based around Valve Software's Half-Life. In this game players must work together against computer controlled enemies and solve puzzles as a team. -### Server Ports +## Server Ports + Sven co-op requires a single port to be opened game ports (default 27015 ) diff --git a/game_eggs/steamcmd_servers/team_fortress_2_classic/README.md b/game_eggs/steamcmd_servers/team_fortress_2_classic/README.md index 410bc742..43548100 100644 --- a/game_eggs/steamcmd_servers/team_fortress_2_classic/README.md +++ b/game_eggs/steamcmd_servers/team_fortress_2_classic/README.md @@ -4,7 +4,8 @@ Team Fortress 2 Classic is a re-imagining of the 2008-2009 era of the original Team Fortress 2, of which is what we consider the "Classic Era", featuring old features that were scrapped and worked upon, or new content such as new weapons and gamemodes. -### Server Ports +## Server Ports + TF2C servers require 1 port to be open, the SourceTV port can also be opened for spectators. | Port | default | diff --git a/game_eggs/steamcmd_servers/the_forest/README.md b/game_eggs/steamcmd_servers/the_forest/README.md index 5361f9a7..1e3b50d7 100644 --- a/game_eggs/steamcmd_servers/the_forest/README.md +++ b/game_eggs/steamcmd_servers/the_forest/README.md @@ -1,20 +1,19 @@ -## 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. +# 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. - +## NOTE -**NOTE** This server requires a Steam Token -You can generate the token on steam at https://steamcommunity.com/dev/managegameservers +You can generate the token on steam at ## Server Ports + 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 | -|---------|---------| -| Server | any | -| Steam | 8766 | -| Query | 27016 | - +| Port | default | +|--------|---------| +| Server | any | +| Steam | 8766 | +| Query | 27016 | diff --git a/game_eggs/steamcmd_servers/tower_unite/README.md b/game_eggs/steamcmd_servers/tower_unite/README.md index f43f9408..06afcf0e 100644 --- a/game_eggs/steamcmd_servers/tower_unite/README.md +++ b/game_eggs/steamcmd_servers/tower_unite/README.md @@ -1,8 +1,10 @@ # Tower Unite + Their desctiption: Every aspect of Tower Unite allows for online multiplayer interaction. It is a living and evolving online game world, driven by the community. Play games online with your friends, or make new friends from across the globe. -### Server Ports +## Server Ports + Tower Unite requires a single port to be opened | Port | default | diff --git a/game_eggs/steamcmd_servers/unturned/README.md b/game_eggs/steamcmd_servers/unturned/README.md index 32b69f98..3376abb0 100644 --- a/game_eggs/steamcmd_servers/unturned/README.md +++ b/game_eggs/steamcmd_servers/unturned/README.md @@ -1,13 +1,15 @@ # Unturned -Steam Description -You're one of the few not yet turned zombie. Keeping it that way will be a challenge. -- Go in guns blazing and attract the attention of everything, living and dead. -- Take a subtle approach sneaking around and making use of distractions. -- Confront and learn to counter special abilities ranging from invisibility to fire breathing to lightning attacks. +Steam Description +You're one of the few not yet turned zombie. Keeping it that way will be a challenge. -### Server Ports -Rocketmod requires 3 ports to run properly. +- Go in guns blazing and attract the attention of everything, living and dead. +- Take a subtle approach sneaking around and making use of distractions. +- Confront and learn to counter special abilities ranging from invisibility to fire breathing to lightning attacks. + +## Server Ports + +Rocketmod requires 3 ports to run properly. | Port | default | |---------|---------| diff --git a/game_eggs/steamcmd_servers/valheim/valheim_plus/README.md b/game_eggs/steamcmd_servers/valheim/valheim_plus/README.md index 072e70f7..feb0c1f7 100644 --- a/game_eggs/steamcmd_servers/valheim/valheim_plus/README.md +++ b/game_eggs/steamcmd_servers/valheim/valheim_plus/README.md @@ -1,10 +1,12 @@ # Valheim Plus Mod ## Valheim + A brutal exploration and survival game for 1-10 players, set in a procedurally-generated purgatory inspired by viking culture. Battle, build, and conquer your way to a saga worthy of Odin’s patronage! https://store.steampowered.com/app/892970/Valheim/ ## Plus Mod + A HarmonyX Mod aimed at improving the gameplay quality of Valheim. The mod includes several different main features including modifiers to ingame stats of players, buildings and entities and a sophisticated system to build and place objects with high precision and a system to modify already placed objects with high precision. The general goal is to provide V+ as a base modification for your gameplay to increase quality of life, change difficulty or have a better experience in general. The mod also comes with a version and configuration control system for servers and users, allowing servers to make sure that only people with the same configuration are able to join their servers. Support: https://github.com/valheimPlus/ValheimPlus Discord: https://discord.gg/AmH6Va97GT @@ -13,10 +15,9 @@ Discord: https://discord.gg/AmH6Va97GT ***All (Server + Clients) need to have a installed Valheim Plus Mod !!!!*** - ## Server Ports | Port | default | |-------|---------| -| Game | 2456 | -| Query | 2457 | +| Game | 2456 | +| Query | 2457 | diff --git a/game_eggs/steamcmd_servers/valheim/valheim_vanilla/README.md b/game_eggs/steamcmd_servers/valheim/valheim_vanilla/README.md index ef747e15..18839d85 100644 --- a/game_eggs/steamcmd_servers/valheim/valheim_vanilla/README.md +++ b/game_eggs/steamcmd_servers/valheim/valheim_vanilla/README.md @@ -1,11 +1,12 @@ # Valheim + A brutal exploration and survival game for 1-10 players, set in a procedurally-generated purgatory inspired by viking culture. Battle, build, and conquer your way to a saga worthy of Odin’s patronage! -https://store.steampowered.com/app/892970/Valheim/ + ## Server Ports | Port | default | |-------|---------| -| Game | 2456 | -| Query | 2457 | \ No newline at end of file +| Game | 2456 | +| Query | 2457 | diff --git a/game_eggs/teeworlds/README.md b/game_eggs/teeworlds/README.md index 3a18c931..6b416887 100644 --- a/game_eggs/teeworlds/README.md +++ b/game_eggs/teeworlds/README.md @@ -1,8 +1,11 @@ # Teeworlds -### From their [Site](https://www.teeworlds.com/) + +## From their [Site](https://www.teeworlds.com/) + Teeworlds is a free online multiplayer game, available for all major operating systems. Battle with up to 16 players in a variety of game modes, including Team Deathmatch and Capture The Flag. You can even design your own maps -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | diff --git a/game_eggs/terraria/README.md b/game_eggs/terraria/README.md index 1a8469da..e421959f 100644 --- a/game_eggs/terraria/README.md +++ b/game_eggs/terraria/README.md @@ -1,13 +1,15 @@ # Terraria ## Minimum RAM warning + You may want to assign a minimum of 768 mb of RAM to a server as it will use around 650 mb to generate the world on the first start. ## Required Server Ports + tModloader, like Terraria, only requires a single port to run. The default is 7777 | Port | default | |---------|---------| | Game | 7777 | -#### Plugins may require ports to be added to the server. +### Plugins may require ports to be added to the server diff --git a/game_eggs/terraria/tmodloader/README.md b/game_eggs/terraria/tmodloader/README.md index 4fa490da..fd75ba46 100644 --- a/game_eggs/terraria/tmodloader/README.md +++ b/game_eggs/terraria/tmodloader/README.md @@ -1,29 +1,33 @@ # tModLoader -### From their [GitHub](https://github.com/tModLoader/tModLoader) + +## From their [GitHub](https://github.com/tModLoader/tModLoader) + tModLoader is essentially a mod that provides a way to load your own mods without having to work directly with Terraria's source code itself. This means you can easily make mods that are compatible with other people's mods, save yourself the trouble of having to decompile and recompile Terraria.exe, and escape from having to understand all of the obscure "intricacies" of Terraria's source code. It is made to work for Terraria 1.3+. -### Install notes +## Install notes + Due to rate limiting the console on the panel cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. -### Minimum RAM warning +## Minimum RAM warning + You may want to assign a minimum of 768 mb of RAM to a server as it will use around 650 mb to generate the world on the first start. +## Server Ports -### Server Ports tModloader, like Terraria, only requires a single port to run. The default is 7777 | Port | default | |---------|---------| | Game | 7777 | -#### Plugins may require ports to be added to the server. +### Plugins may require ports to be added to the server. -### Extra Information +## Extra Information If you want to download mods in the console, the startup command has to be changed. -New startup: +New startup: `./tModLoaderServer -ip 0.0.0.0 -port ${SERVER_PORT} -maxplayers ${MAX_PLAYERS} -savedirectory ~/ -tmlsavedirectory ~/saves -modpath ~/mods` -This will remove the autocreate function, and will thus allow you to download mods and generate world. +This will remove the autocreate function, and will thus allow you to download mods and generate world. Afterwards, you can change it back with the correct world name to start automatic. Word name is set in the configuration panel. \ No newline at end of file diff --git a/game_eggs/terraria/tshock/README.md b/game_eggs/terraria/tshock/README.md index fec56632..16a21fc5 100644 --- a/game_eggs/terraria/tshock/README.md +++ b/game_eggs/terraria/tshock/README.md @@ -1,24 +1,27 @@ # TShock -TShock provides Terraria servers with server-side characters, anti-cheat, and community management tools. https://tshock.co/ +TShock provides Terraria servers with server-side characters, anti-cheat, and community management tools. + +## From their GitHub -### From their GitHub TShock is a toolbox for Terraria servers and communities. That toolbox is jam packed with anti-cheat tools, server-side characters, groups, permissions, item bans, tons of commands, and limitless potential. It's one of a kind. -### Server Ports +## Server Ports + TShock, like Terraria, only requires a single port to run. The default is 7777 | Port | default | |---------|---------| | Game | 7777 | -#### Plugins may require ports to be added to the server. +### Plugins may require ports to be added to the server. + +## Extra Information -### Extra Information If you want to download mods in the console, the startup command has to be changed. -New startup: +New startup: `mono TerrariaServer.exe -ip 0.0.0.0 -port {{SERVER_PORT}} -maxplayers {{MAX_PLAYERS}}` -This will remove the autocreate function, and will thus allow you to download mods and generate world. -Afterwards, you can change it back with the correct world name to start automatic. Word name is set in the configuration panel. \ No newline at end of file +This will remove the autocreate function, and will thus allow you to download mods and generate world. +Afterwards, you can change it back with the correct world name to start automatic. Word name is set in the configuration panel. diff --git a/game_eggs/terraria/vanilla/README.md b/game_eggs/terraria/vanilla/README.md index da96e637..a1758dd1 100644 --- a/game_eggs/terraria/vanilla/README.md +++ b/game_eggs/terraria/vanilla/README.md @@ -3,13 +3,15 @@ Vanilla Terraria egg with support for Journey's End. Currently up to 1.4.0.2 is supported, however future patches will require updates to the install script. ## Minimum RAM warning + You may want to assign a minimum of 768 mb of RAM to a server as it will use around 650 mb to generate the world on the first start. ## Required Server Ports + Terraria only requires a single port to run. The default is 7777 | Port | default | |---------|---------| | Game | 7777 | -#### Plugins may require ports to be added to the server. +### Plugins may require ports to be added to the server diff --git a/game_eggs/tycoon_games/openttd/README.md b/game_eggs/tycoon_games/openttd/README.md index 90f44417..c00a8280 100644 --- a/game_eggs/tycoon_games/openttd/README.md +++ b/game_eggs/tycoon_games/openttd/README.md @@ -1,4 +1,4 @@ -# OpenTTD (https://www.openttd.org) +# [OpenTTD](https://www.openttd.org) OpenTTD is a business simulation game in which players try to earn money via transporting passengers and freight by road, rail, water and air. It is an open-source remake and expansion of the 1995 Chris Sawyer video game Transport Tycoon Deluxe diff --git a/game_eggs/veloren/README.md b/game_eggs/veloren/README.md index 18f0040e..df3bdcd6 100644 --- a/game_eggs/veloren/README.md +++ b/game_eggs/veloren/README.md @@ -1,10 +1,13 @@ # Veloren -### From their [Site](https://veloren.net/) + +## From their [Site](https://veloren.net/) + Veloren is a multiplayer voxel RPG written in Rust. It is inspired by games such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft. Veloren is fully open-source, licensed under GPL 3. It uses original graphics, musics and other assets created by its community. Being contributor-driven, its development community and user community is one and the same: developers, players, artists and musicians come together to develop the game. -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | @@ -12,4 +15,4 @@ Ports required to run the server in a table format. | Game | 14004 | | Metrics | 14005 | -#### Mods/Plugins may require ports to be added to the server. +### Mods/Plugins may require ports to be added to the server diff --git a/game_eggs/vintage_story/README.md b/game_eggs/vintage_story/README.md index 4bffe25f..827a8b9c 100644 --- a/game_eggs/vintage_story/README.md +++ b/game_eggs/vintage_story/README.md @@ -1,18 +1,20 @@ # Vintage Story -#### The Vintage Story Server +## The Vintage Story Server + The server supports mods -#### from the developers +### from the developers Vintage Story is an uncompromising wilderness survival sandbox game inspired by lovecraftian horror themes. Find yourself in a ruined world reclaimed by nature and permeated by unnerving temporal disturbances. Relive the advent of human civilization, or take your own path. New to the game? Make sure to checkout their [starter page](https://wiki.vintagestory.at/index.php?title=Main_Page). -### Server Ports -Vintage Story requires a single port +## Server Ports + +Vintage Story requires a single port | Port | default | |---------|---------| -| Game | 42420 | \ No newline at end of file +| Game | 42420 | diff --git a/game_eggs/vintage_story/vintage_story/egg-vintage-story.json b/game_eggs/vintage_story/egg-vintage-story.json similarity index 100% rename from game_eggs/vintage_story/vintage_story/egg-vintage-story.json rename to game_eggs/vintage_story/egg-vintage-story.json diff --git a/game_eggs/wine/generic/README.md b/game_eggs/wine/generic/README.md index 82294b1d..8164f636 100644 --- a/game_eggs/wine/generic/README.md +++ b/game_eggs/wine/generic/README.md @@ -1,8 +1,10 @@ # Wine Generic -A generic wine image that can be used to install servers that need wine to run. + +A generic wine image that can be used to install servers that need wine to run. Downloads compressed server files and extracts them to a specified folder in `/mnt/server/` I.E. `INSTALL_DIR` = `server/folder` will unpack the server into `/mnt/server//server/folder/` -### Install notes -May require a full custom start command. This is on you to figure out what that is. \ No newline at end of file +## Install notes + +May require a full custom start command. This is on you to figure out what that is. diff --git a/game_eggs/xonotic/xonotic/README.md b/game_eggs/xonotic/xonotic/README.md index 6709ce40..0a17db03 100644 --- a/game_eggs/xonotic/xonotic/README.md +++ b/game_eggs/xonotic/xonotic/README.md @@ -2,7 +2,8 @@ The Free and Fast Arena Shooter -### Server Ports +## Server Ports + Xonotic requires 1 port | Port | default | diff --git a/minecraft/README.md b/minecraft/README.md index 52c0ecaa..802a7e10 100644 --- a/minecraft/README.md +++ b/minecraft/README.md @@ -1,3 +1,3 @@ -## All Minecraft eggs have been migrated to a [new game_eggs folder.](https://github.com/parkervcp/eggs/tree/master/game_eggs/minecraft) +# All Minecraft eggs have been migrated to a [new game_eggs folder.](https://github.com/parkervcp/eggs/tree/master/game_eggs/minecraft) -This folder is only kept for backward compatibility for eggs that are downloading server.properties file from here. \ No newline at end of file +This folder is only kept for backward compatibility for eggs that are downloading server.properties file from here. diff --git a/minecraft/java/README.md b/minecraft/java/README.md index 52c0ecaa..802a7e10 100644 --- a/minecraft/java/README.md +++ b/minecraft/java/README.md @@ -1,3 +1,3 @@ -## All Minecraft eggs have been migrated to a [new game_eggs folder.](https://github.com/parkervcp/eggs/tree/master/game_eggs/minecraft) +# All Minecraft eggs have been migrated to a [new game_eggs folder.](https://github.com/parkervcp/eggs/tree/master/game_eggs/minecraft) -This folder is only kept for backward compatibility for eggs that are downloading server.properties file from here. \ No newline at end of file +This folder is only kept for backward compatibility for eggs that are downloading server.properties file from here. diff --git a/monitoring/prometheus/README.md b/monitoring/prometheus/README.md index 4766566b..b741ab7f 100644 --- a/monitoring/prometheus/README.md +++ b/monitoring/prometheus/README.md @@ -1,14 +1,17 @@ # Prometheus -### From the [Prometheus](https://github.com/prometheus/prometheus) GitHub repository +## From the [Prometheus](https://github.com/prometheus/prometheus) GitHub repository + The Prometheus monitoring system and time series database. -### Resource consumption +## Resource consumption + As Prometheus is a monitoring software that saves data in a timeseries database, it can take up massive amounts of disk space. Due to Prometheus design, a huge memory consumption is also possible. To get started, a minimum of 3GB RAM and >=2.5GB disk space is recommended. Keep in mind that those numbers can grow pretty quick for large monitored environments! -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | diff --git a/software/code-server/README.md b/software/code-server/README.md index f1863224..2665a786 100644 --- a/software/code-server/README.md +++ b/software/code-server/README.md @@ -1,6 +1,6 @@ # Code-Server -### From the [Code-Server](https://github.com/cdr/code-server) GitHub +## From the [Code-Server](https://github.com/cdr/code-server) GitHub Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. diff --git a/software/elasticsearch/README.md b/software/elasticsearch/README.md index 78721fc6..9b140f95 100644 --- a/software/elasticsearch/README.md +++ b/software/elasticsearch/README.md @@ -1,13 +1,14 @@ # Elasticsearch -### From the [Elasticsearch](https://github.com/elastic/elasticsearch) GitHub +## From the [Elasticsearch](https://github.com/elastic/elasticsearch) GitHub Run [Elasticsearch](https://github.com/elastic/elasticsearch) on any machine anywhere and access it in the browser. -### vm.max_map_count requirement -Please follow this for the vm.max_map_count requirement: https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#_set_vm_max_map_count_to_at_least_262144 +## vm.max_map_count requirement -### Server Ports +Please follow this for the vm.max_map_count requirement: + +## Server Ports Ports required to run the server in a table format. diff --git a/software/gitea/README.md b/software/gitea/README.md index 3431606c..7f555ba8 100644 --- a/software/gitea/README.md +++ b/software/gitea/README.md @@ -1,11 +1,12 @@ # Gitea + [Gitea](https://gitea.io/en-us/) is a community managed lightweight code hosting solution written in Go. It is published under the MIT license. -### Server Ports +## Server Ports Ports required to run the server in a table format. | Port | default | | ---- | ------- | | App | 3000 | -| SSH | 2020 | \ No newline at end of file +| SSH | 2020 | diff --git a/software/grafana/README.md b/software/grafana/README.md index 31ffddcb..53200083 100644 --- a/software/grafana/README.md +++ b/software/grafana/README.md @@ -1,20 +1,24 @@ # Grafana -### From the [Grafana](https://github.com/grafana/grafana) GitHub +## From the [Grafana](https://github.com/grafana/grafana) GitHub + The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more. -### Initial credentials -After the first start of Grafana, you can login using the following credentials: - - Username: admin - - Password: admin +## Initial credentials + +After the first start of Grafana, you can login using the following credentials: + +- Username: admin +- Password: admin + +## Update support -### Update support The egg _should_ keep the data and conf folder when reinstalling. Therefore a reinstallation with "latest" as the selected version can be used to update Grafana. If you want to reset the server completly, remove the `conf` and `data` directories manually before reinstalling. -### Server Ports +## Server Ports Ports required to run the server in a table format. diff --git a/software/haste-server/README.md b/software/haste-server/README.md index 3d2e1881..b337cb5f 100644 --- a/software/haste-server/README.md +++ b/software/haste-server/README.md @@ -1,8 +1,13 @@ # haste-server -### Their [Github](https://github.com/seejohnrun/haste-server) + +## Their [Github](https://github.com/seejohnrun/haste-server) + Host your own [Hastebin](https://hastebin.com). -### Server Ports + +## Server Ports + Ports required to run the server in a table format. + | Port | default | | ---- | ------- | | Game | 7777 | diff --git a/software/rabbitmq/README.md b/software/rabbitmq/README.md index 6fddaf19..8679398e 100644 --- a/software/rabbitmq/README.md +++ b/software/rabbitmq/README.md @@ -1,32 +1,36 @@ # RabbitMQ -### From the [RabbitMQ](https://www.rabbitmq.com/) website +## From the [RabbitMQ](https://www.rabbitmq.com/) website + RabbitMQ is the most widely deployed open source message broker. -### Installation +## Installation + Follow the common egg installation guide to install the egg on your Pterodactyl instance. When setting up a server, the latest RabbitMQ version will be used by default. With pretty new and old versions of RabbitMQ, you might have to adjust the used Erlang version. This can be archived by adjusting the version number of the used image (e. g. `ghcr.io/pterodactyl/yolks:erlang_22` instead of `ghcr.io/parkervcp/yolks:erlang_24`). -### Configuration +## Configuration + Configuring RabbitMQ in Pterodactyl is only possible using the config files. This means: - - Configure the server itself as normal using `/home/container/etc/rabbitmq/rabbitmq.conf` - - Enable plugins using the plugin file located at `/home/container/etc/rabbitmq/enabled_plugins` - - Configure users and vhosts through a [definitions.json](https://www.rabbitmq.com/definitions.html) + +- Configure the server itself as normal using `/home/container/etc/rabbitmq/rabbitmq.conf` +- Enable plugins using the plugin file located at `/home/container/etc/rabbitmq/enabled_plugins` +- Configure users and vhosts through a [definitions.json](https://www.rabbitmq.com/definitions.html) You can set the path to the used `definitions.json` using the `load_definitions` option in your config. Note that RabbitMQ versions prior to 3.8.6 will require a properly configured management plugin to do so! -The easiest way to get a working `definitions.json` is to setup a local instance with the -management plugin. You can configure your instance there and load the definitions as stated by uploading them. +The easiest way to get a working `definitions.json` is to setup a local instance with the management plugin. You can configure your instance there and load the definitions as stated by uploading them. -By default, only `listeners.tcp.default` is configured to match your primary allocation. +By default, only `listeners.tcp.default` is configured to match your primary allocation. If you want to expose some other port (e. g. the web management interface) you have to manually configure the port in your `rabbitmq.conf`. -### Update support +## Update support + The egg _should_ keep the `etc` folder when reinstalling, to prevent destroying the configuration by accident. Therefore a reinstallation with "latest" as the selected version can be used to update RabbitMQ. If you want to reset the server completly, remove the `etc` directory manually before reinstalling. diff --git a/stock_eggs/minecraft/README.md b/stock_eggs/minecraft/README.md index 89d19035..f4a61dec 100644 --- a/stock_eggs/minecraft/README.md +++ b/stock_eggs/minecraft/README.md @@ -1,6 +1,11 @@ # Minecraft -All the default minecraft things +All the default minecraft things ## Server Ports -The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. \ No newline at end of file + +The minecraft server requires a single port for access (default 25565) but plugins may require extra ports to enabled for the server. + +| Port | Default | +|------|---------| +| Game | 25565 | diff --git a/stock_eggs/rust/README.md b/stock_eggs/rust/README.md index 22d0e83b..57ad10ea 100644 --- a/stock_eggs/rust/README.md +++ b/stock_eggs/rust/README.md @@ -1,15 +1,18 @@ -### Rust +# Rust + The only aim in Rust is to survive. To do this you will need to overcome struggles such as hunger, thirst and cold. Build a fire. Build a shelter. Kill animals for meat. Protect yourself from other players, and kill them for meat. Create alliances with other players and form a town. Do whatever it takes to survive. -### Minimum RAM warning +## Minimum RAM warning + The server requires at least 4096MB to run properly. This is mostly needed for the startup only, once it is running (depending on your world size) it should consume less. -### Server Ports +## Server Ports + Ports required to run the server. -| Port | default | -|---------|---------| +| Port | default | +|----------------|-----------| | Game and Query | 28015 UDP | -| RCON | 28016 TCP | -| Rust+ App | 28082 TCP | +| RCON | 28016 TCP | +| Rust+ App | 28082 TCP | diff --git a/stock_eggs/source-engine/README.md b/stock_eggs/source-engine/README.md index 17586b96..40bc2803 100644 --- a/stock_eggs/source-engine/README.md +++ b/stock_eggs/source-engine/README.md @@ -4,13 +4,15 @@ The Source Dedicated Server or SRCDS is a tool that runs the server component of This also covers games that are installed using the steamcmd utility. -### Server Ports +## Server Ports + Many of these servers will require the steam query ports to be open for the server. The default steam query port is 27015 ## ARK Survival Evolved ### Port Requirements + The ARK server requires 4 ports minimum. | Port | default | @@ -24,9 +26,10 @@ Please note the server may not show up on steam game server lists due to this re ## Counter Strike: Global Offensive -Counter-Strike: Global Offensive (CS: GO) expands upon the team-based action gameplay that it pioneered when it was launched 19 years ago. CS: GO features new maps, characters, weapons, and game modes, and delivers updated versions of the classic CS content (de_dust2, etc.). +Counter-Strike: Global Offensive (CS: GO) expands upon the team-based action gameplay that it pioneered when it was launched 19 years ago. CS: GO features new maps, characters, weapons, and game modes, and delivers updated versions of the classic CS content (de_dust2, etc.). ### Port Requirements + | Port | default | |----------|---------| | Game | 27015 | @@ -38,24 +41,27 @@ This is a generic one size fit's all egg that supports srcds game servers. This is not for games like Counter Strike 1.6 which is an HLDS title. See [HLDS server](game_eggs/steamcmd_servers/hlds_server) ### Port Requirements + | Port | default | |----------|---------| | Game | 27015 | ## Garry's Mod -Garry's Mod is a physics sandbox. There aren't any predefined aims or goals. We give you the tools and leave you to play. +Garry's Mod is a physics sandbox. There aren't any predefined aims or goals. We give you the tools and leave you to play. ### Port Requirements + | Port | default | |----------|---------| | Game | 27015 | ## Insurgency -Take to the streets for intense close quarters combat, where a team's survival depends upon securing crucial strongholds and destroying enemy supply in this multiplayer and cooperative Source Engine based experience. +Take to the streets for intense close quarters combat, where a team's survival depends upon securing crucial strongholds and destroying enemy supply in this multiplayer and cooperative Source Engine based experience. ### Port Requirements + | Port | default | |----------|---------| | Game | 27015 | @@ -65,6 +71,7 @@ Take to the streets for intense close quarters combat, where a team's survival d Nine distinct classes provide a broad range of tactical abilities and personalities. Constantly updated with new game modes, maps, equipment and, most importantly, hats! ### Port Requirements + | Port | default | |----------|---------| | Game | 27015 | diff --git a/stock_eggs/voice-servers/README.md b/stock_eggs/voice-servers/README.md index 40aed5be..665395ea 100644 --- a/stock_eggs/voice-servers/README.md +++ b/stock_eggs/voice-servers/README.md @@ -4,7 +4,8 @@ Mumble is an open source, low-latency, high quality voice chat software primarily intended for use while gaming. -## Required Server Ports +### Required Server Ports + Mumble only requires a single port to run. The default is 64738 | Port | default | @@ -15,7 +16,8 @@ Mumble only requires a single port to run. The default is 64738 Use crystal clear sound to communicate with your team mates cross-platform with military-grade security, lag-free performance & unparalleled reliability and uptime. -## Required Server Ports +### Required Server Ports + Teamspeak 3 only requires a single port to run. The default is 9987 Other ports for ServerQuery and File Transfers are required for specific things. @@ -26,4 +28,4 @@ Other ports for ServerQuery and File Transfers are required for specific things. | Query | 10011 | | Files | 30033 | -By default pteordactyl sets the query port to the same as the server port. \ No newline at end of file +By default pteordactyl sets the query port to the same as the server port. diff --git a/storage/minio/README.md b/storage/minio/README.md index 73fcc597..3d5998e6 100644 --- a/storage/minio/README.md +++ b/storage/minio/README.md @@ -1,24 +1,25 @@ # minio s3 ## Features + Auto generate keys on server creation bypassing default minio keys ## Update + Auto update minio to latest version using "update" startup feature Automatic Key rotation using "rotate" startup feature ## Auto Rotate + It's possible to rotate your keys by changing the startup option to "rotate" - Once this is changed restart your server and it will automatically move your current keys to old and create your new keys - Be sure to change your startup back to "normal" once you have started your server using "rotate". This will ensure that you don't accidentally rotate your keys twice ## Known Issues Double encryption may occur if you manually manipulate files in the keys directory -#### Key rotation is handled automatically, DO NOT manually delete files in keys directory +### Key rotation is handled automatically, DO NOT manually delete files in keys directory diff --git a/voice_servers/lavalink/README.md b/voice_servers/lavalink/README.md index ad8b7549..68308238 100644 --- a/voice_servers/lavalink/README.md +++ b/voice_servers/lavalink/README.md @@ -1,12 +1,15 @@ # Lavalink Server -### From their [Github](https://github.com/freyacodes/Lavalink) + +## From their [Github](https://github.com/freyacodes/Lavalink) + Standalone audio sending node based on Lavaplayer and JDA-Audio. Allows for sending audio without it ever reaching any of your shards. -### Server Ports +## Server Ports + Ports required to run the server in a table format. | Port | default | |----------|----------| | Lavalink | 2333 | -#### Mods/Plugins may require ports to be added to the server. +### Mods/Plugins may require ports to be added to the server diff --git a/voice_servers/teaspeak/README.md b/voice_servers/teaspeak/README.md index b3a8ee56..010b4142 100644 --- a/voice_servers/teaspeak/README.md +++ b/voice_servers/teaspeak/README.md @@ -1,12 +1,15 @@ # TeaSpeak -### From their [Website](https://teaspeak.de/) -Because a license fee is not my cup of tea! -### Server Ports +## From their [Website](https://teaspeak.de/) + +Because a license fee is not my cup of tea! + +## Server Ports + Ports required to run the server in a table format. | Port | default | |---------|---------| | Voice | 9987 | | Query | 10101 | -| File | 30303 | \ No newline at end of file +| File | 30303 | diff --git a/voice_servers/ts3_manager/README.md b/voice_servers/ts3_manager/README.md index 8d64dd67..731d290f 100644 --- a/voice_servers/ts3_manager/README.md +++ b/voice_servers/ts3_manager/README.md @@ -1,5 +1,6 @@ # TS3 Manager -### [Website](https://www.ts3.app/) + +## [Website](https://www.ts3.app/) TS3 Manager is a simple and lightwight webbased Teamspeak Webinterface @@ -8,6 +9,7 @@ TS3 Manager is a simple and lightwight webbased Teamspeak Webinterface Connect with your IP from your Pteroserver and the assigned Port. Add your IP to TS Server Withlist ### Server Ports + Ports required to run the server in a table format. | Port | default |