[General] Repository Cleanup (#14)

- Cleaned up root README.
  - Added note pointing to `games-standalone` repository to avoid confusion.
  - Updated the Eggs list to be a simple list without duplicate names taking up space.
  - Fixed Egg name typos.
  - Added Eggs missing from list.
  - Rebranded Garry's Mod egg to be a "fork" rather than a "rework".
- Updated LICENSE year.
- Updated CONTRIBUTING to have corrected hyperlinks (still contains references to Pterodactyl docs and `eggs/scripts` folder though).
This commit is contained in:
Red-Thirten 2024-05-10 20:49:20 -07:00 committed by GitHub
parent b0de0bac95
commit 501c5aae44
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 170 additions and 424 deletions

View File

@ -1,6 +1,6 @@
# How to contribute
You can contribute by either creating a new pull request or testing [existing pull requests](https://github.com/parkervcp/eggs/pulls) and commenting on whether the egg works for you or not. Testing is very important and helpful!
You can contribute by either creating a new pull request or testing [existing pull requests](https://github.com/pelican-eggs/games-steamcmd/pulls) and commenting on whether the egg works for you or not. Testing is very important and helpful!
## General rules for eggs
@ -15,10 +15,10 @@ You can contribute by either creating a new pull request or testing [existing pu
We don't need 8 miles of the install script.
4. Keep it small.
Only use what is absolutely needed. The [yolks install images](https://github.com/parkervcp/yolks#installation-images) already contain the most basic packages that speeds up the installation process.
Only use what is absolutely needed. The [yolks install images](https://github.com/pelican-eggs/yolks#installation-images) already contain the most basic packages that speeds up the installation process.
5. Use the stock images.
If you need something in an image, open a PR in [my yolks repo](https://github.com/parkervcp/yolks) where it can be reviewed and built. Self-hosted or third-party images won't be accepted for security reasons.
If you need something in an image, open a PR in [my yolks repo](https://github.com/pelican-eggs/yolks) where it can be reviewed and built. Self-hosted or third-party images won't be accepted for security reasons.
6. Export eggs from the panel
We ask that you use the panel to manage and export eggs.
@ -28,9 +28,9 @@ You can contribute by either creating a new pull request or testing [existing pu
Look at existing eggs to see how they work. In most cases, you can take the existing egg as your new template. There's a brief documentation on how to [create eggs](https://pterodactyl.io/community/config/eggs/creating_a_custom_egg.html) and [Docker images](https://pterodactyl.io/community/config/eggs/creating_a_custom_image.html).
Use existing Docker images for your egg. You can find them in [Parkers Yolks fork](https://github.com/parkervcp/yolks) and [Pterodactyl Yolks](https://github.com/pterodactyl/yolks).
Use existing Docker images for your egg. You can find them in [Parkers Yolks fork](https://github.com/pelican-eggs/yolks) and [Pterodactyl Yolks](https://github.com/pterodactyl/yolks).
We have a collection of [existing install script snippets](https://github.com/parkervcp/eggs/tree/master/scripts) that you can use.
We have a collection of [existing install script snippets](https://github.com/pelican-eggs/eggs/tree/master/scripts) that you can use.
## Step 1

View File

@ -1,6 +1,6 @@
MIT
Copyright (c) 2018 Michael Parker <parker@parkervcp.com> and Contributors
Copyright (c) 2024 Michael Parker <parker@parkervcp.com> and Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

472
README.md
View File

@ -1,381 +1,127 @@
# SteamCMD Servers
# Game Eggs (SteamCMD)
This is a collection of servers that use SteamCMD to install.
#### This is a collection of Eggs for game servers that use SteamCMD to install.
## 7 Days To Die
> [!NOTE]
>
> Looking for game servers that *don't* install with SteamCMD?
>
> See our [`games-standalone` repository](https://github.com/pelican-eggs/games-standalone) for Eggs that may not be included here.
[7 Days To Die](7_days_to_die)
---
## Abiotic Factor
[Abiotic Factor](abiotic_factor/)
## ARK: Survival Ascended
[ARK: Survival Ascended](ark_survival_ascended)
## ARK: Survival Evolved
[ARK: Survival Evolved](ark_survival_evolved)
## Arma
### Collection Directory (Alphabetical):
* [7 Days To Die](7_days_to_die)
* [Abiotic Factor](abiotic_factor/)
* [ARK: Survival Ascended](ark_survival_ascended)
* [ARK: Survival Evolved](ark_survival_evolved)
* [Arma](arma)
* [Arma 3](arma/arma3)
* [Arma Reforger](arma/arma_reforger)
## Assetto Corsa
[Assetto Corsa](assetto_corsa)
## Astro Colony
[Astro Colony](astro_colony)
## Avorion
[Avorion](avorion)
## Barotrauma
[Barotrauma](barotrauma)
## BATTALION: Legacy
[BATTALION: Legacy](/battalion_legacy)
## Black Mesa
[Black Mesa](black_mesa)
## Citadel: Forged with Fire
[citadel](citadel)
## Colony Survival
[Colony Survival](colony_survival)
## Conan Exiles
[Conan Exiles](conan_exiles)
## Core Keeper
[Core Keeper](core_keeper)
## Counter-Strike
[Counter-Strike](counter_strike)
## Craftopia
[Craftopia](craftopia)
## CryoFall
[Cryofall](cryofall)
## DayZ (Experimental)
[DayZ (Experimental)](dayz-experimental)
## DDNet
[DDNet](ddnet)
## Dead Matter
[Dead Matter](dead_matter)
## Don't Starve Together
[Don't Starve Together](dont_starve)
## ECO
[ECO](eco)
## Empyrion
[Empyrion - Galactic Survival](empyrion)
## Enshrouded
[Enshrouded](enshrouded)
## Fistful of Frags
[Fistful of Frags](fof)
## Foundry
[Foundry](foundry)
## Frozen Flame
[Frozen Flame](frozen_flame)
## Ground Branch
[Ground Branch](ground_branch)
## HLDS Server
[HLDS Server](hlds_server)
* [Assetto Corsa](assetto_corsa)
* [Astro Colony](astro_colony)
* [Avorion](avorion)
* [Barotrauma](barotrauma)
* [BATTALION: Legacy](/battalion_legacy)
* [Black Mesa](black_mesa)
* [Citadel: Forged with Fire](citadel)
* [Colony Survival](colony_survival)
* [Conan Exiles](conan_exiles)
* [Core Keeper](core_keeper)
* [Counter-Strike](counter_strike)
* [Craftopia](craftopia)
* [Cryofall](cryofall)
* [DayZ (Experimental)](dayz-experimental)
* [DDNet](ddnet)
* [Dead Matter](dead_matter)
* [Don't Starve Together](dont_starve)
* [ECO](eco)
* [Empyrion - Galactic Survival](empyrion)
* [Enshrouded](enshrouded)
* [Fistful of Frags](fof)
* [Foundry](foundry)
* [Frozen Flame](frozen_flame)
* [Garry's Mod](gmod)
* [Ground Branch](ground_branch)
* [HLDS Server](hlds_server)
* [HLDS Vanilla](hlds_server/vanilla)
* [ReHLDS](hlds_server/rehlds)
## Holdfast: Nations At War
[Holdfast: Nations At War](holdfast)
## HumanitZ
[HumanitZ](humanitz)
## Hurtworld
[Hurtworld](hurtworld)
## Icarus
* [Holdfast: Nations At War](holdfast)
* [HumanitZ](humanitz)
* [Hurtworld](hurtworld)
* [Icarus](icarus)
## Insurgency: Sandstorm
[Insurgency: Sandstorm](insurgency_sandstorm)
## Iosoccer
[iosoccer](iosoccer)
## Killing Floor 2
[Killing Floor 2](killing_floor_2)
## Left 4 Dead
[Left 4 Dead](left4dead)
## Left 4 Dead 2
[Left 4 Dead](left4dead_2)
## Longvinter
[Longvinter](longvinter)
## Modiverse
[Modiverse](modiverse)
## Mordhau
[Mordhau](mordhau)
## Mount & Blade II: Bannerlord
[Mount & Blade II: Bannerlord](mount_blade_II_bannerlord)
## Myth of Empires
[Myth of Empires](myth_of_empires)
## Necesse
[Necesse](necesse)
## Neos VR
[Neos VR](neosvr)
## No More Room in Hell
[No More Room in Hell](nmrih)
## No Love Lost
[No Love Lost](no_love_lost)
## No One Survived
[No One Survived](no_one_survived)
## Nova-Life: Amboise
[Nova-Life: Amboise](novalife_amboise)
## Onset
[Onset](onset)
## Open Fortress
[Open Fortress](open_fortress)
## Operation Harsh Doorstop
[Operation Harsh Doorstop](operation_harsh_doorstop)
## Palworld
[Palworld](palworld)
## Pavlov VR
[Pavlov VR](pavlov_vr)
## PixARK
[PixARK](pixark)
## Portal Knights
[Portal Knights](portal_knights)
## Post Scriptum
[Post Scriptum](post_scriptum)
## Project Zomboid
[Project Zomboid](project_zomboid)
## Quake Live
[Quake Live](quake_live)
## Resonite
[Resonite](resonite)
## Rising World
* [Insurgency: Sandstorm](insurgency_sandstorm)
* [iosoccer](iosoccer)
* [Killing Floor 2](killing_floor_2)
* [Left 4 Dead](left4dead)
* [Left 4 Dead 2](left4dead_2)
* [Longvinter](longvinter)
* [Modiverse](modiverse)
* [Mordhau](mordhau)
* [Mount & Blade II: Bannerlord](mount_blade_II_bannerlord)
* [Myth of Empires](myth_of_empires)
* [Necesse](necesse)
* [Neos VR](neosvr)
* [No More Room in Hell](nmrih)
* [No Love Lost](no_love_lost)
* [No One Survived](no_one_survived)
* [Nova-Life: Amboise](novalife_amboise)
* [Onset](onset)
* [Open Fortress](open_fortress)
* [Operation: Harsh Doorstop](operation_harsh_doorstop)
* [Palworld](palworld)
* [Pavlov VR](pavlov_vr)
* [PixARK](pixark)
* [Portal Knights](portal_knights)
* [Post Scriptum](post_scriptum)
* [Project Zomboid](project_zomboid)
* [Quake Live](quake_live)
* [Resonite](resonite)
* [Rising World](rising_world)
* [Legacy Java](rising_world/legacy)
* [Unity](rising_world/unity)
## Risk of Rain 2
[Risk Of Rain 2](risk_of_rain_2)
## Rust
* [Risk Of Rain 2](risk_of_rain_2)
* [Rust](rust)
* [Autowipe](rust/rust_autowipe)
* [Staging](rust/rust_staging)
## Satisfactory
[Satisfactory](satisfactory)
## SCP: Secret Laboratory
* [Satisfactory](satisfactory)
* [SCP: Secret Laboratory](scpsl)
* [dedicated](scpsl/dedicated)
* [exiled](scpsl/exiled)
## Smalland: Survive the Wilds
[Smalland: Survive the Wilds](smalland_survive_the_wilds)
## Solace Crafting
[Solace Crafting](solace_crafting)
## Soldat
[Soldat](soldat)
## Sons of the Forest
[Sons of the Forest](sonsoftheforest)
## Space Engineers
[Space Engineers](space_engineers)
* [default](space_engineers/default)
* [torch](space_engineers/torch)
## Squad
[Squad](squad)
## Starbound
[Starbound](starbound)
## Stationeers
[Stationeers](stationeers)
* [Stationeers Vanilla](stationeers/stationeers_vanilla)
* [Stationeers BepInEx](stationeers/stationeers_bepinex)
## Stormworks: Build and Rescue
[Stormworks: Build and Rescue](stormworks)
## Subnautica: Nitrox Mod
[Subnautica: Nitrox Mod](subnautica_nitrox_mod)
## Sven coop
[Sven Co-op](svencoop)
## Swords 'n Magic and Stuff
[Swords 'n Magic and Stuff](swords_'n_Magic_and_Stuff)
## Team Fortress 2 Classic
[Team Fortress 2 Classic](team_fortress_2_classic)
## TerraTech Worlds
[TerraTech Worlds](terratech_worlds)
## The Forest
[The Forest](the_forest)
## The Front
[The Front](thefront)
## The Isle
[The Isle](the_isle)
* [Evrima](the_isle/evrima/)
## Tower Unite
[Tower Unite](tower_unite)
## Truck Sim
* [Truck Sim](truck-simulator)
* [American Truck Simulator](truck-simulator/american-truck-simulator/)
* [Euro Truck Simulator 2](truck-simulator/euro-truck-simulator2/)
## Unturned
[Unturned](unturned)
## V Rising
[V Rising](v_rising)
* [V Rising Vanilla](v_rising/v_rising_vanilla)
* [V Rising BepInex](v_rising/v_rising_bepinex)
## Valheim
[Valheim](valheim)
* [Valheim Vanilla](valheim/valheim_vanilla)
* [Valheim BepInEx](valheim/valheim_bepinex)
* [Valheim Plus Mod](valheim/valheim_plus)
## VEIN
[VEIN](vein)
## Wurm Unlimited
[Wurm Unlimited](wurm_unlimited/)
* [Dedicated](scpsl/dedicated)
* [Exiled](scpsl/exiled)
* [Smalland: Survive the Wilds](smalland_survive_the_wilds)
* [Solace Crafting](solace_crafting)
* [Soldat](soldat)
* [Sons of the Forest](sonsoftheforest)
* [Space Engineers](space_engineers)
* [Default](space_engineers/default)
* [Torch](space_engineers/torch)
* [Squad](squad)
* [Starbound](starbound)
* [Stationeers](stationeers)
* [Vanilla](stationeers/stationeers_vanilla)
* [BepInEx](stationeers/stationeers_bepinex)
* [Stormworks: Build and Rescue](stormworks)
* [Subnautica: Nitrox Mod](subnautica_nitrox_mod)
* [Sven Co-op](svencoop)
* [Swords 'n Magic and Stuff](swords_'n_Magic_and_Stuff)
* [Team Fortress 2 Classic](team_fortress_2_classic)
* [TerraTech Worlds](terratech_worlds)
* [The Forest](the_forest)
* [The Isle](the_isle)
* [Evrima](the_isle/evrima)
* [The Front](thefront)
* [Tower Unite](tower_unite)
* [Truck Simulator](truck-simulator)
* [American Truck Simulator](truck-simulator/american-truck-simulator)
* [Euro Truck Simulator 2](truck-simulator/euro-truck-simulator2)
* [Unturned](unturned)
* [V Rising](v_rising)
* [Vanilla](v_rising/v_rising_vanilla)
* [BepInex](v_rising/v_rising_bepinex)
* [Valheim](valheim)
* [Vanilla](valheim/valheim_vanilla)
* [BepInEx](valheim/valheim_bepinex)
* [Plus Mod](valheim/valheim_plus)
* [VEIN](vein)
* [Wurm Unlimited](wurm_unlimited/)

View File

@ -1,3 +1,3 @@
# Garry's Mod egg
# Garry's Mod egg
A copy of the one already available in Pterodacty with the addition of the "maxplayers" setting.

View File

@ -1,54 +1,54 @@
{
"_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
"meta": {
"version": "PTDL_v1"
},
"exported_at": "2018-03-10T13:48:24+01:00",
"name": "Garry's Mod - Reworked",
"author": "vilhelm@prytznet.se",
"description": "Garry's Mod, is a sandbox physics game created by Garry Newman, and developed by his company, Facepunch Studios.",
"image": "quay.io\/pterodactyl\/core:source",
"startup": ".\/srcds_run -game garrysmod -console -maxplayers {{MAX_PLAYERS}} -port {{SERVER_PORT}} +ip 0.0.0.0 +map {{SRCDS_MAP}} -strictportbind -norestart +sv_setsteamaccount {{STEAM_ACC}}",
"config": {
"files": "{}",
"startup": "{\r\n \"done\": \"gameserver Steam ID\",\r\n \"userInteraction\": []\r\n}",
"logs": "{\r\n \"custom\": true,\r\n \"location\": \"logs\/latest.log\"\r\n}",
"stop": "quit"
},
"scripts": {
"installation": {
"script": "#!\/bin\/bash\r\n# Garry's Mod Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\napt -y update\r\napt -y --no-install-recommends install curl lib32gcc1 ca-certificates\r\n\r\ncd \/tmp\r\ncurl -sSL -o steamcmd.tar.gz http:\/\/media.steampowered.com\/installer\/steamcmd_linux.tar.gz\r\n\r\nmkdir -p \/mnt\/server\/steamcmd\r\ntar -xzvf steamcmd.tar.gz -C \/mnt\/server\/steamcmd\r\ncd \/mnt\/server\/steamcmd\r\n\r\n# SteamCMD fails otherwise for some reason, even running as root.\r\n# This is changed at the end of the install process anyways.\r\nchown -R root:root \/mnt\r\n\r\nexport HOME=\/mnt\/server\r\n.\/steamcmd.sh +login anonymous +force_install_dir \/mnt\/server +app_update 4020 +quit\r\n\r\nmkdir -p \/mnt\/server\/.steam\/sdk32\r\ncp -v linux32\/steamclient.so ..\/.steam\/sdk32\/steamclient.so",
"container": "ubuntu:16.04",
"entrypoint": "bash"
}
},
"variables": [
{
"name": "Map",
"description": "The default map for the server.",
"env_variable": "SRCDS_MAP",
"default_value": "gm_flatgrass",
"user_viewable": 1,
"user_editable": 1,
"rules": "required|string|alpha_dash"
},
{
"name": "Steam Account Token",
"description": "The Steam Account Token required for the server to be displayed publicly.",
"env_variable": "STEAM_ACC",
"default_value": "",
"user_viewable": 1,
"user_editable": 1,
"rules": "required|string|alpha_num|size:32"
},
{
"name": "Player Slots",
"description": "The amount of player slots on the server.",
"env_variable": "MAX_PLAYERS",
"default_value": "32",
"user_viewable": 1,
"user_editable": 1,
"rules": "required|integer|max:128"
}
]
{
"_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
"meta": {
"version": "PTDL_v1"
},
"exported_at": "2018-03-10T13:48:24+01:00",
"name": "Garry's Mod - Reworked",
"author": "vilhelm@prytznet.se",
"description": "Garry's Mod, is a sandbox physics game created by Garry Newman, and developed by his company, Facepunch Studios.",
"image": "quay.io\/pterodactyl\/core:source",
"startup": ".\/srcds_run -game garrysmod -console -maxplayers {{MAX_PLAYERS}} -port {{SERVER_PORT}} +ip 0.0.0.0 +map {{SRCDS_MAP}} -strictportbind -norestart +sv_setsteamaccount {{STEAM_ACC}}",
"config": {
"files": "{}",
"startup": "{\r\n \"done\": \"gameserver Steam ID\",\r\n \"userInteraction\": []\r\n}",
"logs": "{\r\n \"custom\": true,\r\n \"location\": \"logs\/latest.log\"\r\n}",
"stop": "quit"
},
"scripts": {
"installation": {
"script": "#!\/bin\/bash\r\n# Garry's Mod Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\napt -y update\r\napt -y --no-install-recommends install curl lib32gcc1 ca-certificates\r\n\r\ncd \/tmp\r\ncurl -sSL -o steamcmd.tar.gz http:\/\/media.steampowered.com\/installer\/steamcmd_linux.tar.gz\r\n\r\nmkdir -p \/mnt\/server\/steamcmd\r\ntar -xzvf steamcmd.tar.gz -C \/mnt\/server\/steamcmd\r\ncd \/mnt\/server\/steamcmd\r\n\r\n# SteamCMD fails otherwise for some reason, even running as root.\r\n# This is changed at the end of the install process anyways.\r\nchown -R root:root \/mnt\r\n\r\nexport HOME=\/mnt\/server\r\n.\/steamcmd.sh +login anonymous +force_install_dir \/mnt\/server +app_update 4020 +quit\r\n\r\nmkdir -p \/mnt\/server\/.steam\/sdk32\r\ncp -v linux32\/steamclient.so ..\/.steam\/sdk32\/steamclient.so",
"container": "ubuntu:16.04",
"entrypoint": "bash"
}
},
"variables": [
{
"name": "Map",
"description": "The default map for the server.",
"env_variable": "SRCDS_MAP",
"default_value": "gm_flatgrass",
"user_viewable": 1,
"user_editable": 1,
"rules": "required|string|alpha_dash"
},
{
"name": "Steam Account Token",
"description": "The Steam Account Token required for the server to be displayed publicly.",
"env_variable": "STEAM_ACC",
"default_value": "",
"user_viewable": 1,
"user_editable": 1,
"rules": "required|string|alpha_num|size:32"
},
{
"name": "Player Slots",
"description": "The amount of player slots on the server.",
"env_variable": "MAX_PLAYERS",
"default_value": "32",
"user_viewable": 1,
"user_editable": 1,
"rules": "required|integer|max:128"
}
]
}