From 2b6a555505e380c99150a579a9135d5f4ae3899a Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sat, 23 Mar 2024 19:57:42 -0400 Subject: [PATCH 1/8] Create egg-super-tux-kart.json --- .../SuperTuxKart/egg-super-tux-kart.json | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 game_eggs/SuperTuxKart/egg-super-tux-kart.json diff --git a/game_eggs/SuperTuxKart/egg-super-tux-kart.json b/game_eggs/SuperTuxKart/egg-super-tux-kart.json new file mode 100644 index 00000000..38332704 --- /dev/null +++ b/game_eggs/SuperTuxKart/egg-super-tux-kart.json @@ -0,0 +1,31 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2024-03-23T19:32:36-04:00", + "name": "SuperTuxKart", + "author": "mattamn107@github.com", + "description": "Egg for hosting a SuperTuxKart Server. \r\nhttps:\/\/supertuxkart.net\/Main_Page\r\n\r\nFirst install will take a while because the games source code and assets will be downloaded and the games executable will have to be compiled.\r\n\r\nTo change server settings, stop the server then edit the 'config.xml' file in the root of the container. When done save the file and start the server.\r\n\r\nTo update the server (only should have to be done when the games code or assets are updated) in panel go to Servers > SuperTuxKart Server > Manage > Reinstall. This will download the updated code\/assets (should exclude anything that didn't change) and recompile the executable.\r\n\r\nCurrently this is setup to run a local lan server. To make this a wan server (available in the SuperTuxKart online lobby list) read the document at this link and make the necessary changes to the startup command: https:\/\/github.com\/supertuxkart\/stk-code\/blob\/master\/NETWORKING.md", + "features": null, + "docker_images": { + "ghcr.io\/parkervcp\/yolks:debian": "ghcr.io\/parkervcp\/yolks:debian" + }, + "file_denylist": [], + "startup": ".\/bin\/supertuxkart --server-config=config.xml --lan-server=Pterodactyl_Server --network-console", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Available command:\"\r\n}", + "logs": "{}", + "stop": "quit" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n\r\n# Install build tools\r\necho \"deb http:\/\/deb.debian.org\/debian bullseye-backports main\" >> \/etc\/apt\/sources.list && \\\r\napt-get update && apt-get -y full-upgrade && \\\r\n apt-get install -y build-essential cmake libbluetooth-dev libsdl2-dev \\\r\n libcurl4-openssl-dev libenet-dev libfreetype6-dev libharfbuzz-dev \\\r\n libjpeg-dev libogg-dev libopenal-dev libpng-dev \\\r\n libssl-dev libvorbis-dev libmbedtls-dev pkg-config zlib1g-dev subversion\r\n\r\nif [ ! -d \"\/mnt\/server\/stk-code\" ] && [ ! -d \"\/mnt\/server\/stk-assets\" ]; then\r\n \r\n #clone code repo\r\n git clone https:\/\/github.com\/supertuxkart\/stk-code \/mnt\/server\/stk-code\r\n \r\n #get assets\r\n svn co https:\/\/svn.code.sf.net\/p\/supertuxkart\/code\/stk-assets \/mnt\/server\/stk-assets\r\n \r\n # go into the stk-code directory\r\n cd \/mnt\/server\/stk-code\r\n \r\n # create and enter the cmake_build directory\r\n mkdir cmake_build\r\n \r\nelse\r\n\r\n #update existing stuff\r\n cd \/mnt\/server\/stk-assets\r\n svn up\r\n \r\n cd \/mnt\/server\/stk-code\r\n git pull\r\n\r\n\r\nfi\r\n\r\n#build the server\r\ncd cmake_build\r\ncmake .. -DSERVER_ONLY=ON\r\nmake\r\n\r\n#copy binary to root\/bin and make it executable\r\nmkdir \/mnt\/server\/bin\r\ncp \/mnt\/server\/stk-code\/cmake_build\/bin\/supertuxkart \/mnt\/server\/bin\/supertuxkart\r\nchmod +x \/mnt\/server\/bin\/supertuxkart\r\n\r\n#copy data folder\r\ncp -r \/mnt\/server\/stk-code\/data \/mnt\/server\/data\r\n\r\n#copy extra assets to data folder\r\nmv \/mnt\/server\/stk-assets\/library \/mnt\/server\/data\/library\r\nmv \/mnt\/server\/stk-assets\/models \/mnt\/server\/data\/models\r\nmv \/mnt\/server\/stk-assets\/music \/mnt\/server\/data\/music\r\nmv \/mnt\/server\/stk-assets\/sfx \/mnt\/server\/data\/sfx\r\nmv \/mnt\/server\/stk-assets\/textures \/mnt\/server\/data\/textures\r\nmv \/mnt\/server\/stk-assets\/tracks \/mnt\/server\/data\/tracks\r\nmv \/mnt\/server\/stk-assets\/karts \/mnt\/server\/data\/karts\r\n\r\n# Delete repo's to save disk space.\r\n#rm -rf \/mnt\/server\/stk-code && rm -rf \/mnt\/server\/stk-assets", + "container": "ghcr.io\/parkervcp\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [] +} From 2527806a839265f364ca78bf3743d40617653667 Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sat, 23 Mar 2024 21:08:12 -0400 Subject: [PATCH 2/8] Create ReadMe.md --- game_eggs/SuperTuxKart/ReadMe.md | 37 ++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 game_eggs/SuperTuxKart/ReadMe.md diff --git a/game_eggs/SuperTuxKart/ReadMe.md b/game_eggs/SuperTuxKart/ReadMe.md new file mode 100644 index 00000000..2bfb4df1 --- /dev/null +++ b/game_eggs/SuperTuxKart/ReadMe.md @@ -0,0 +1,37 @@ +# SuperTuxKart + +SuperTuxKart is a 3D open-source arcade racer with a variety characters, tracks, and modes to play. + +## Files downloaded from their [Github](https://github.com/supertuxkart/stk-code) and [SourceForge](https://svn.code.sf.net/p/supertuxkart/code/stk-assets) + +To compile the executable as outlined in their [building instruction](https://github.com/supertuxkart/stk-code/blob/master/INSTALL.md) and [source control documentation](https://supertuxkart.net/Source_control) files from both of these sources is required to be downloaded. + +## [Documentation](https://github.com/supertuxkart/stk-code/blob/master/NETWORKING.md) + +Essentailly this is a standard build of the regular SuperTuxKart client but with a special flag when being compiled that produces a GUI-less binary optimized for size and memory usage. + +## Install notes + +First install will take a while because the games source code and assets will be downloaded and the games executable will have to be compiled. + +## Installation/System Requirements +| | Bare Minimum | Recommended | +|---------|---------|---------| +| RAM | 1GiB | 1GiB | +| Storage | 3GiB | 5GiB | + +## Server Ports + +| Port | default | +|---------|---------| +| Game | 2759 | + +### Notes + +To change server settings, stop the server then edit the 'config.xml' file in the root of the container. When done save the file and start the server. + +2759 is the default port, but any port can be used. You will have to manually change it in the config.xml file. + +To update the server (only should have to be done when the games code or assets are updated) in panel go to Servers > SuperTuxKart Server > Manage > Reinstall. This will download the updated code/assets (should exclude anything that didn't change) and recompile the executable. + +Currently this is setup to run a local lan server. To make this a wan server (available in the SuperTuxKart online lobby list) read the document at this link and make the necessary changes to the [startup command](https://github.com/supertuxkart/stk-code/blob/master/NETWORKING.md). From 269c2351a948d671688620b1fa65d2f07fc0b7eb Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sat, 23 Mar 2024 21:11:21 -0400 Subject: [PATCH 3/8] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b5965c86..116283fc 100644 --- a/README.md +++ b/README.md @@ -344,6 +344,8 @@ If you are reading this it looks like you are looking to add an egg to your serv * [VEIN](game_eggs/steamcmd_servers/vein) * [Wurm Unlimited](game_eggs/steamcmd_servers/wurm_unlimited/) +[SuperTuxKart](game_eggs/SuperTuxKart) + [Teeworlds](game_eggs/teeworlds) * [Teeworlds](game_eggs/teeworlds/teeworlds) From 3eec7dce7adcd3371954153068e8a1b2b3cdcd79 Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sat, 23 Mar 2024 21:13:22 -0400 Subject: [PATCH 4/8] Update ReadMe.md --- game_eggs/SuperTuxKart/ReadMe.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/game_eggs/SuperTuxKart/ReadMe.md b/game_eggs/SuperTuxKart/ReadMe.md index 2bfb4df1..97baacea 100644 --- a/game_eggs/SuperTuxKart/ReadMe.md +++ b/game_eggs/SuperTuxKart/ReadMe.md @@ -8,7 +8,7 @@ To compile the executable as outlined in their [building instruction](https://gi ## [Documentation](https://github.com/supertuxkart/stk-code/blob/master/NETWORKING.md) -Essentailly this is a standard build of the regular SuperTuxKart client but with a special flag when being compiled that produces a GUI-less binary optimized for size and memory usage. +Essentially this is a standard build of the regular SuperTuxKart client but with a special flag when being compiled that produces a GUI-less binary optimized for size and memory usage. ## Install notes From b790f9f8d6a7c1d161a4678254c9e494ab4059dd Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sat, 23 Mar 2024 21:36:22 -0400 Subject: [PATCH 5/8] Update egg-super-tux-kart.json --- game_eggs/SuperTuxKart/egg-super-tux-kart.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/game_eggs/SuperTuxKart/egg-super-tux-kart.json b/game_eggs/SuperTuxKart/egg-super-tux-kart.json index 38332704..5103380c 100644 --- a/game_eggs/SuperTuxKart/egg-super-tux-kart.json +++ b/game_eggs/SuperTuxKart/egg-super-tux-kart.json @@ -4,7 +4,7 @@ "version": "PTDL_v2", "update_url": null }, - "exported_at": "2024-03-23T19:32:36-04:00", + "exported_at": "2024-03-23T21:35:53-04:00", "name": "SuperTuxKart", "author": "mattamn107@github.com", "description": "Egg for hosting a SuperTuxKart Server. \r\nhttps:\/\/supertuxkart.net\/Main_Page\r\n\r\nFirst install will take a while because the games source code and assets will be downloaded and the games executable will have to be compiled.\r\n\r\nTo change server settings, stop the server then edit the 'config.xml' file in the root of the container. When done save the file and start the server.\r\n\r\nTo update the server (only should have to be done when the games code or assets are updated) in panel go to Servers > SuperTuxKart Server > Manage > Reinstall. This will download the updated code\/assets (should exclude anything that didn't change) and recompile the executable.\r\n\r\nCurrently this is setup to run a local lan server. To make this a wan server (available in the SuperTuxKart online lobby list) read the document at this link and make the necessary changes to the startup command: https:\/\/github.com\/supertuxkart\/stk-code\/blob\/master\/NETWORKING.md", @@ -13,7 +13,7 @@ "ghcr.io\/parkervcp\/yolks:debian": "ghcr.io\/parkervcp\/yolks:debian" }, "file_denylist": [], - "startup": ".\/bin\/supertuxkart --server-config=config.xml --lan-server=Pterodactyl_Server --network-console", + "startup": ".\/bin\/supertuxkart --server-config=config.xml --lan-server=test --network-console", "config": { "files": "{}", "startup": "{\r\n \"done\": \"Available command:\"\r\n}", @@ -22,7 +22,7 @@ }, "scripts": { "installation": { - "script": "#!\/bin\/bash\r\n\r\n# Install build tools\r\necho \"deb http:\/\/deb.debian.org\/debian bullseye-backports main\" >> \/etc\/apt\/sources.list && \\\r\napt-get update && apt-get -y full-upgrade && \\\r\n apt-get install -y build-essential cmake libbluetooth-dev libsdl2-dev \\\r\n libcurl4-openssl-dev libenet-dev libfreetype6-dev libharfbuzz-dev \\\r\n libjpeg-dev libogg-dev libopenal-dev libpng-dev \\\r\n libssl-dev libvorbis-dev libmbedtls-dev pkg-config zlib1g-dev subversion\r\n\r\nif [ ! -d \"\/mnt\/server\/stk-code\" ] && [ ! -d \"\/mnt\/server\/stk-assets\" ]; then\r\n \r\n #clone code repo\r\n git clone https:\/\/github.com\/supertuxkart\/stk-code \/mnt\/server\/stk-code\r\n \r\n #get assets\r\n svn co https:\/\/svn.code.sf.net\/p\/supertuxkart\/code\/stk-assets \/mnt\/server\/stk-assets\r\n \r\n # go into the stk-code directory\r\n cd \/mnt\/server\/stk-code\r\n \r\n # create and enter the cmake_build directory\r\n mkdir cmake_build\r\n \r\nelse\r\n\r\n #update existing stuff\r\n cd \/mnt\/server\/stk-assets\r\n svn up\r\n \r\n cd \/mnt\/server\/stk-code\r\n git pull\r\n\r\n\r\nfi\r\n\r\n#build the server\r\ncd cmake_build\r\ncmake .. -DSERVER_ONLY=ON\r\nmake\r\n\r\n#copy binary to root\/bin and make it executable\r\nmkdir \/mnt\/server\/bin\r\ncp \/mnt\/server\/stk-code\/cmake_build\/bin\/supertuxkart \/mnt\/server\/bin\/supertuxkart\r\nchmod +x \/mnt\/server\/bin\/supertuxkart\r\n\r\n#copy data folder\r\ncp -r \/mnt\/server\/stk-code\/data \/mnt\/server\/data\r\n\r\n#copy extra assets to data folder\r\nmv \/mnt\/server\/stk-assets\/library \/mnt\/server\/data\/library\r\nmv \/mnt\/server\/stk-assets\/models \/mnt\/server\/data\/models\r\nmv \/mnt\/server\/stk-assets\/music \/mnt\/server\/data\/music\r\nmv \/mnt\/server\/stk-assets\/sfx \/mnt\/server\/data\/sfx\r\nmv \/mnt\/server\/stk-assets\/textures \/mnt\/server\/data\/textures\r\nmv \/mnt\/server\/stk-assets\/tracks \/mnt\/server\/data\/tracks\r\nmv \/mnt\/server\/stk-assets\/karts \/mnt\/server\/data\/karts\r\n\r\n# Delete repo's to save disk space.\r\n#rm -rf \/mnt\/server\/stk-code && rm -rf \/mnt\/server\/stk-assets", + "script": "#!\/bin\/bash\r\n\r\n# Install build tools\r\necho \"deb http:\/\/deb.debian.org\/debian bullseye-backports main\" >> \/etc\/apt\/sources.list && \\\r\napt-get update && apt-get -y full-upgrade && \\\r\n apt-get install -y build-essential cmake libbluetooth-dev libsdl2-dev \\\r\n libcurl4-openssl-dev libenet-dev libfreetype6-dev libharfbuzz-dev \\\r\n libjpeg-dev libogg-dev libopenal-dev libpng-dev \\\r\n libssl-dev libvorbis-dev libmbedtls-dev pkg-config zlib1g-dev subversion\r\n\r\nif [ ! -d \"\/mnt\/server\/stk-code\" ] && [ ! -d \"\/mnt\/server\/stk-assets\" ]; then\r\n \r\n #clone code repo\r\n git clone https:\/\/github.com\/supertuxkart\/stk-code \/mnt\/server\/stk-code\r\n \r\n #get assets\r\n svn co https:\/\/svn.code.sf.net\/p\/supertuxkart\/code\/stk-assets \/mnt\/server\/stk-assets\r\n \r\n # go into the stk-code directory\r\n cd \/mnt\/server\/stk-code\r\n \r\n # create and enter the cmake_build directory\r\n mkdir cmake_build\r\n \r\nelse\r\n\r\n #update existing stuff\r\n cd \/mnt\/server\/stk-assets\r\n svn up\r\n \r\n cd \/mnt\/server\/stk-code\r\n git pull\r\n\r\n\r\nfi\r\n\r\n#build the server\r\ncd cmake_build\r\ncmake .. -DSERVER_ONLY=ON\r\nmake\r\n\r\n#copy binary to root\/bin and make it executable\r\nmkdir \/mnt\/server\/bin\r\ncp \/mnt\/server\/stk-code\/cmake_build\/bin\/supertuxkart \/mnt\/server\/bin\/supertuxkart\r\nchmod +x \/mnt\/server\/bin\/supertuxkart\r\n\r\n#copy data folder\r\ncp -r \/mnt\/server\/stk-code\/data \/mnt\/server\/data\r\n\r\n#copy extra assets to data folder\r\ncd \/mnt\/server\/stk-assets\r\ncp -r library models music sfx textures tracks karts \/mnt\/server\/data\/\r\n\r\n# Delete repo's to save disk space.\r\n#rm -rf \/mnt\/server\/stk-code && rm -rf \/mnt\/server\/stk-assets", "container": "ghcr.io\/parkervcp\/installers:debian", "entrypoint": "bash" } From c2d4b4064eb5f3f43abd224cea05670ad3615282 Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sat, 23 Mar 2024 21:37:47 -0400 Subject: [PATCH 6/8] Update README.md --- game_eggs/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/game_eggs/README.md b/game_eggs/README.md index e56554b9..66212e30 100644 --- a/game_eggs/README.md +++ b/game_eggs/README.md @@ -242,6 +242,8 @@ * [VEIN](steamcmd_servers/vein) * [Wurm Unlimited](steamcmd_servers/wurm_unlimited/) +[SuperTuxKart](SuperTuxKart) + [Teeworlds](teeworlds) [Terraria](terraria) From 9061aa4c2765c8a173d7478cd720ce5b671fba73 Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sun, 24 Mar 2024 08:31:58 -0400 Subject: [PATCH 7/8] Update ReadMe.md --- game_eggs/SuperTuxKart/ReadMe.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/game_eggs/SuperTuxKart/ReadMe.md b/game_eggs/SuperTuxKart/ReadMe.md index 97baacea..c5fb073f 100644 --- a/game_eggs/SuperTuxKart/ReadMe.md +++ b/game_eggs/SuperTuxKart/ReadMe.md @@ -2,10 +2,6 @@ SuperTuxKart is a 3D open-source arcade racer with a variety characters, tracks, and modes to play. -## Files downloaded from their [Github](https://github.com/supertuxkart/stk-code) and [SourceForge](https://svn.code.sf.net/p/supertuxkart/code/stk-assets) - -To compile the executable as outlined in their [building instruction](https://github.com/supertuxkart/stk-code/blob/master/INSTALL.md) and [source control documentation](https://supertuxkart.net/Source_control) files from both of these sources is required to be downloaded. - ## [Documentation](https://github.com/supertuxkart/stk-code/blob/master/NETWORKING.md) Essentially this is a standard build of the regular SuperTuxKart client but with a special flag when being compiled that produces a GUI-less binary optimized for size and memory usage. From 171aa952e26eecc998bcafcaeb6d489ab68f436f Mon Sep 17 00:00:00 2001 From: mattman107 <65982675+mattman107@users.noreply.github.com> Date: Sun, 24 Mar 2024 08:34:28 -0400 Subject: [PATCH 8/8] Update egg-super-tux-kart.json --- game_eggs/SuperTuxKart/egg-super-tux-kart.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/game_eggs/SuperTuxKart/egg-super-tux-kart.json b/game_eggs/SuperTuxKart/egg-super-tux-kart.json index 5103380c..09208b73 100644 --- a/game_eggs/SuperTuxKart/egg-super-tux-kart.json +++ b/game_eggs/SuperTuxKart/egg-super-tux-kart.json @@ -7,7 +7,7 @@ "exported_at": "2024-03-23T21:35:53-04:00", "name": "SuperTuxKart", "author": "mattamn107@github.com", - "description": "Egg for hosting a SuperTuxKart Server. \r\nhttps:\/\/supertuxkart.net\/Main_Page\r\n\r\nFirst install will take a while because the games source code and assets will be downloaded and the games executable will have to be compiled.\r\n\r\nTo change server settings, stop the server then edit the 'config.xml' file in the root of the container. When done save the file and start the server.\r\n\r\nTo update the server (only should have to be done when the games code or assets are updated) in panel go to Servers > SuperTuxKart Server > Manage > Reinstall. This will download the updated code\/assets (should exclude anything that didn't change) and recompile the executable.\r\n\r\nCurrently this is setup to run a local lan server. To make this a wan server (available in the SuperTuxKart online lobby list) read the document at this link and make the necessary changes to the startup command: https:\/\/github.com\/supertuxkart\/stk-code\/blob\/master\/NETWORKING.md", + "description": "Egg for hosting a SuperTuxKart Server.", "features": null, "docker_images": { "ghcr.io\/parkervcp\/yolks:debian": "ghcr.io\/parkervcp\/yolks:debian"