[General] Repository Cleanup

- Cleaned up root README:
  - Added notes pointing to `games-steamcmd` & `minecraft` repositories to avoid confusion.
  - Removed Egg listings for SteamCMD and Minecraft.
  - Updated the Eggs list to be a simple list without duplicate names taking up space.
  - Fixed Egg name and hyperlink typos.
  - Added Eggs missing from list.
  - Reorganized various Egg folders. This includes:
    - De-nesting when nesting wasn't optimal
    - Making names lowercase to fix alphabetization
    - Fixing misleading or incorrect names
- 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 21:44:52 -07:00
parent f3f988073c
commit de6d9f5189
11 changed files with 91 additions and 271 deletions

View File

@ -1,6 +1,6 @@
# How to contribute # 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 ## 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. We don't need 8 miles of the install script.
4. Keep it small. 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. 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 6. Export eggs from the panel
We ask that you use the panel to manage and export eggs. 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). 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 ## Step 1

View File

@ -1,6 +1,6 @@
MIT 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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

350
README.md
View File

@ -1,271 +1,91 @@
# Game Eggs # Game Eggs (Standalone)
[Among Us](among_us) #### This is a collection of Eggs for game servers that are standalone in their installation (ie. don't require 3rd party tools like SteamCMD, etc).
* [Impostor Server](among_us/impostor_server) > [!NOTE]
* [CrewLink Server](among_us/crewlink_server) >
> Looking for game servers that install with **SteamCMD**?
>
> See our [`games-steamcmd` repository](https://github.com/pelican-eggs/games-steamcmd) for Eggs that may not be included here.
[BeamNG.drive](beamng) > [!NOTE]
>
> Looking for one of the many different **Minecraft** server versions/forks?
>
> See our [`minecraft` repository](https://github.com/pelican-eggs/minecraft) for these Eggs.
* [BeamMP Server](beamng/beammp) ---
* [KissMP](beamng/kissmp)
[ClassiCube](classicube) ### Collection Directory (Alphabetical):
* [MCGalaxy](classicube/mcgalaxy) * [Among Us](among_us)
* [Impostor Server](among_us/impostor_server)
[Clone Hero](clone_hero) * [CrewLink Server](among_us/crewlink_server)
* [BeamNG.drive](beamng)
[CS2D](cs2d) * [BeamMP Server](beamng/beammp)
* [KissMP](beamng/kissmp)
[Cube Engine](cubeengine) * [ClassiCube](classicube)
* [AssaultCube](cubeengine/assaultcube) * [MCGalaxy](classicube/mcgalaxy)
* [Cube 2: Sauerbraten](cubeengine/cube2) * [Clone Hero](clone_hero)
* [CS2D](cs2d)
[DDRaceNetwork](ddracenetwork/) * [Cube Engine](cubeengine)
* [AssaultCube](cubeengine/assaultcube)
[Doom](doom) * [Cube 2: Sauerbraten](cubeengine/cube2)
* [Zandronum](doom/zandronum) * [DDRaceNetwork](ddracenetwork)
* [Doom](doom)
[ET Legacy](enemy_territory/etlegacy) * [Zandronum](doom/zandronum)
* [Escape from Tarkov (Singleplayer)](eft)
[Factorio](factorio) * [Factorio](factorio)
* [Vanilla](factorio/factorio)
* [Vanilla](factorio/factorio) * [ModUpdate](factorio/factorio-modupdate)
* [ModUpdate](factorio/factorio-modupdate) * [Clusterio](factorio/clusterio)
* [Clusterio](factorio/clusterio) * [Foundry VTT](foundry_vtt)
* [FTL: Tachyon](ftl_tachyon)
[FTL: Tachyon](ftl/tachyon) * [Grand Theft Auto](gta)
* GTA V
[Grand Theft Auto](gta) * [FiveM](gta/fivem)
* [ragecoop](gta/ragecoop)
* GTA V * [RageMP](gta/ragemp)
* [FiveM](gta/fivem) * [alt:V](gta/altv)
* [ragecoop](gta/ragecoop) * GTA SA
* [RageMP](gta/ragemp) * [Multi Theft Auto](gta/mtasa)
* [alt:V](gta/altv) * [SA-MP](gta/samp)
* [OpenMp](gta/openmp)
* GTA SA * GTA
* [Multi Theft Auto](gta/mtasa) * [GTAC](gta/gtac)
* [SA-MP](gta/samp) * [Hogwarp](hogwarp)
* [OpenMp](gta/openmp) * [Kerbal Space Program](ksp)
* [League Sandbox](leaguesandbox)
* GTA * [Los Angeles Crimes](losangelescrimes)
* [GTAC](gta/gtac) * [Mindustry](mindustry)
* [Minetest](minetest)
[Hogwarp](hogwarp) * [Medal of Honor: Allied Assault](mohaa)
* [Neverwinter Nights: Enhanced Edition](neverwinter_nights_ee)
[Kerbal Space Program](ksp) * [OpenArena](openarena)
* [OpenRA](openra)
[Los Angeles Crimes](losangelescrimes) * [Dune2000](openra/openra_dune2000)
* [Red Alert](openra/openra_red_alert)
[League Sandbox](leaguesandbox) * [Tiberian Dawn](openra/openra_tiberian_dawn)
* [OpenRCT2](openrct2)
[Mindustry](mindustry) * [OpenTTD](openttd)
* [Path Of Titans](path_of_titans)
[Minecraft](minecraft) * [Red Dead Redemption](rdr)
* [RedM](rdr/redm)
* [Bedrock](minecraft/bedrock) Servers for Bedrock Minecraft (Windows 10, mobile, console) * [Rimworld](rimworld)
* [Bedrock](minecraft/bedrock/bedrock) * [Open World](rimworld/open_world)
* [gomint](minecraft/bedrock/gomint) * [Rimworld Together](rimworld/together)
* [LiteLoaderBDS](bedrock/LiteLoader-bedrock) * [Spacestation 14](spacestation_14)
* [Nukkit](minecraft/bedrock/nukkit) * [Starmade](starmade)
* [PocketMine MP](minecraft/bedrock/pocketmine_mp) * [SuperTuxCart](supertuxkart)
* [Teeworlds](teeworlds)
* [Java](minecraft/java) Servers for Java Minecraft * [Terraria](terraria)
* [CurseForge](minecraft/java/curseforge) * [tModLoader](terraria/tmodloader)
* [Cuberite](minecraft/java/cuberite) * [TShock](terraria/tshock)
* [Fabric](minecraft/java/fabric) * [Vanilla](terraria/vanilla)
* [Feather](minecraft/java/feather) * [Urban Terror](urbanterror)
* [Feed The Beast](minecraft/java/ftb) * [Veloren](veloren)
* [Forge](minecraft/java/forge) * [Vintage Story](vintage_story)
* [Glowstone](minecraft/java/glowstone) * [Wolfenstein: Enemy Territory](wolfenstein_enemy_territory)
* [Limbo](minecraft/java/limbo) * [ET: Legacy](wolfenstein_enemy_territory/etlegacy)
* [Magma](minecraft/java/magma) * [Wine (Generic/Template Egg)](wine/generic)
* [Mohist](minecraft/java/mohist) * [Xonotic](xonotic)
* [NanoLimbo](minecraft/java/nanolimbo)
* [NeoForge](minecraft/java/neoforge)
* [Paper](minecraft/java/paper)
* [Folia](minecraft/java/folia)
* [Purpur](minecraft/java/purpur)
* [Spigot](minecraft/java/spigot)
* [SpongeForge](minecraft/java/spongeforge)
* [SpongeVanilla](minecraft/java/spongevanilla)
* [Technic](minecraft/java/technic)
* [VanillaCord](minecraft/java/vanillacord)
* [Crossplay](minecraft/crossplay/) servers for crossplay between Bedrock and Java edition
* [Purpur-GeyserMC-Floodgate](minecraft/crossplay/purpur-geysermc-floodgate/)
* [Proxies](minecraft/proxy) Minecraft Server Proxies
* [Java](minecraft/proxy/java)
* [Travertine](minecraft/proxy/java/travertine)
* [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)
[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)
[Path Of Titans](path_of_titans)
[Red Dead Redemption](rdr)
* [RedM](rdr/redm)
[Spacestation 14](spacestation_14)
[Rimworld](rimworld)
* [Open World](rimworld/open_world)
* [Rimworld Together](rimworld/together)
[Starmade](starmade)
[SteamCMD Servers](steamcmd_servers) These eggs use SteamCMD to install
* [7 Days to Die](steamcmd_servers/7_days_to_die)
* [ARK: Survival Ascended](steamcmd_servers/ark_survival_ascended)
* [ARK: Survival Evolved](steamcmd_servers/ark_survival_evolved)
* [Arma](steamcmd_servers/arma)
* [Arma 3](steamcmd_servers/arma/arma3)
* [Arma Reforger](steamcmd_servers/arma/arma_reforger)
* [Assetto Corsa](steamcmd_servers/assetto_corsa)
* [Astro Colony](steamcmd_servers/astro_colony)
* [Astroneer](steamcmd_servers/astroneer)
* [Avorion](steamcmd_servers/avorion)
* [Barotrauma](steamcmd_servers/barotrauma)
* [BATTALION: Legacy](steamcmd_servers/battalion_legacy)
* [Black Mesa](steamcmd_servers/black_mesa)
* [Citadel: Forged with Fire](steamcmd_servers/citadel)
* [Colony Survival](steamcmd_servers/colony_survival)
* [Conan Exiles](steamcmd_servers/conan_exiles)
* [Core Keeper](steamcmd_servers/core_keeper)
* [Counter-Strike](steamcmd_servers/counter_strike/)
* [Counter-Strike: Source](steamcmd_servers/counter_strike/counter_strike_source/)
* [Counter-Strike 2](steamcmd_servers/counter_strike/counter_strike_2/)
* [Craftopia](game_eggs/steamcmd_servers/craftopia)
* [CryoFall](steamcmd_servers/cryofall)
* [DayZ (Experimental)](steamcmd_servers/dayz-experimental)
* [Dead Matter](steamcmd_servers/dead_matter)
* [DDNet](steamcmd_servers/ddnet)
* [Don't Starve Together](steamcmd_servers/dont_starve)
* [ECO](steamcmd_servers/eco)
* [Empyrion - Galactic Survival](steamcmd_servers/empyrion)
* [Enshrouded](steamcmd_servers/enshrouded)
* [Fistful of Frags](steamcmd_servers/fof)
* [Frozen Flame](steamcmd_servers/frozen_flame)
* [Ground Branch](steamcmd_servers/ground_branch)
* [HLDS Server](steamcmd_servers/hlds_server)
* [HLDS Vanilla](steamcmd_servers/hlds_server/vanilla)
* [ReHLDS](steamcmd_servers/hlds_server/rehlds)
* [Holdfast: Nations At War](steamcmd_servers/holdfast)
* [HumanitZ](steamcmd_servers/humanitz)
* [Hurtworld](steamcmd_servers/hurtworld)
* [Icarus](steamcmd_servers/icarus)
* [Insurgency: Sandstorm](steamcmd_servers/insurgency_sandstorm)
* [iosoccer](steamcmd_servers/iosoccer)
* [Killing Floor 2](steamcmd_servers/killing_floor_2)
* [Left 4 Dead](steamcmd_servers/left4dead)
* [Left 4 Dead 2](steamcmd_servers/left4dead_2)
* [Longvinter](steamcmd_servers/longvinter)
* [Modiverse](steamcmd_servers/modiverse)
* [Mordhau](steamcmd_servers/mordhau)
* [Mount & Blade II: Bannerlord](steamcmd_servers/mount_blade_II_bannerlord)
* [Myth of Empires](steamcmd_servers/myth_of_empires)
* [Necesse](steamcmd_servers/necesse)
* [Neos VR](steamcmd_servers/neosvr)
* [No More Room in Hell](steamcmd_servers/nmrih)
* [No Love Lost](steamcmd_servers/no_love_lost)
* [No One Survived](steamcmd_servers/no_one_survived)
* [Nova-Life: Amboise](steamcmd_servers/novalife_amboise)
* [Onset](steamcmd_servers/onset)
* [Open Fortress](steamcmd_servers/open_fortress)
* [Operation Harsh Doorstop](steamcmd_servers/operation_harsh_doorstop)
* [Palworld](steamcmd_servers/palworld)
* [Pavlov VR](steamcmd_servers/pavlov_vr)
* [PixARK](steamcmd_servers/pixark)
* [Portal Knights](steamcmd_servers/portal_knights)
* [Post Scriptum](steamcmd_servers/post_scriptum)
* [Project Zomboid](steamcmd_servers/project_zomboid)
* [Quake Live](steamcmd_servers/quake_live)
* [Resonite](steamcmd_servers/resonite)
* [Rising World](steamcmd_servers/rising_world)
* [Legacy Java](steamcmd_servers/rising_world/legacy)
* [Unity](steamcmd_servers/rising_world/unity)
* [Risk Of Rain 2](steamcmd_servers/risk_of_rain_2)
* [Rust](steamcmd_servers/rust)
* [Autowipe](steamcmd_servers/rust/rust_autowipe)
* [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)
* [Smalland: Survive the Wilds](steamcmd_servers/smalland_survive_the_wilds)
* [Solace Crafting](steamcmd_servers/solace_crafting)
* [Soldat](steamcmd_servers/soldat)
* [Sons of the Forest](steamcmd_servers/sonsoftheforest)
* [Space Engineers](steamcmd_servers/space_engineers)
* [default](steamcmd_servers/space_engineers/default)
* [torch](steamcmd_servers/space_engineers/torch)
* [Squad](steamcmd_servers/squad)
* [Starbound](steamcmd_servers/starbound)
* [Stationeers](steamcmd_servers/stationeers)
* [Stationeers Vanilla](steamcmd_servers/stationeers/stationeers_vanilla)
* [Stationeers BepInEx](steamcmd_servers/stationeers/stationeers_bepinex)
* [Stormworks: Build and Rescue](steamcmd_servers/stormworks)
* [Subnautica: Nitrox Mod](steamcmd_servers/subnautica_nitrox_mod)
* [Sven Co-op](steamcmd_servers/svencoop)
* [Swords 'n Magic and Stuff](steamcmd_servers/swords_'n_Magic_and_Stuff)
* [Team Fortress 2 Classic](steamcmd_servers/team_fortress_2_classic)
* [TerraTech Worlds](steamcmd_servers/terratech_worlds)
* [The Forest](steamcmd_servers/the_forest)
* [The Front](steamcmd_servers/thefront)
* [The Isle](steamcmd_servers/the_isle)
* [Evrima](steamcmd_servers/the_isle/evrima)
* [Tower Unite](steamcmd_servers/tower_unite)
* [Truck Sim](steamcmd_servers/truck-simulator)
* [American Truck Simulator](steamcmd_servers/truck-simulator/american-truck-simulator/)
* [Euro Truck Simulator 2](steamcmd_servers/truck-simulator/euro-truck-simulator2/)
* [Unturned](steamcmd_servers/unturned)
* [V Rising](steamcmd_servers/v_rising)
* [V Rising Vanilla](steamcmd_servers/v_rising/v_rising_vanilla)
* [V Rising BepInex](steamcmd_servers/v_rising/v_rising_bepinex)
* [Valheim](steamcmd_servers/valheim)
* [Valheim Vanilla](steamcmd_servers/valheim/valheim_vanilla)
* [Valheim BepInEx](steamcmd_servers/valheim/valheim_bepinex)
* [Valheim Plus Mod](steamcmd_servers/valheim/valheim_plus)
* [VEIN](steamcmd_servers/vein)
* [Wurm Unlimited](steamcmd_servers/wurm_unlimited/)
[Teeworlds](teeworlds)
[Terraria](terraria)
* [tModLoader](terraria/tmodloader)
* [TShock](terraria/tshock)
* [Vanilla](terraria/vanilla)
[Tycoon Games](tycoon_games)
* [OpenRCT2](tycoon_games/openrct2)
* [OpenTTD](tycoon_games/openttd)
[Veloren](veloren)
[Vintage Story](vintage_story)
[Xonotic](xonotic/xonotic)
[FoundryVTT](FoundryVTT)