Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

Added: Core Keeper #2056

Merged
merged 15 commits into from
Mar 13, 2023
Merged

Added: Core Keeper #2056

merged 15 commits into from
Mar 13, 2023

Conversation

Attackwave
Copy link
Contributor

Description

Added: Core Keeper

Checklist for all submissions

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you tested and reviewed your changes with confidence that everything works?
  • Did you branch your changes and PR from that branch and not from your master branch?
    • If not, why?:

New egg Submissions

  1. Does your submission pass tests (server is connectable)?
  2. Does your egg use a custom docker image?
    • Have you tried to use a generic image?
    • Did you PR the necessary changes to make it work?
  3. Have you added the egg to the main README.md and any other README files in subdirectories of the egg (e.g /game_eggs) according to the alphabetical order?
  4. Have you added a unique README.md for the egg you are adding according to the alphabetical order?

Attackwave and others added 6 commits January 13, 2023 12:49
Add Core Keeper
Added Core Keeper
Added Core Keeper
Added server port info
- steamcmd default script
- game port
- xvfb display depth text fix
- fixed startup script
@QuintenQVD0
Copy link
Collaborator

QuintenQVD0 commented Jan 13, 2023

For me it is 11pm so I go to sleep, I test it tomorrow.

@Attackwave
Copy link
Contributor Author

Attackwave commented Jan 14, 2023

Same time here...

This night I remembered something about the GameID. I'll test the behavior when the GameID and the world index are specified. I assume that the GameID is only needed once at startup to create the world. Only the created world should then be selectable via the world index.

I'll describe the behavior in the README

@QuintenQVD0
Copy link
Collaborator

Same time here...

This night I remembered something about the GameID. I'll test the behavior when the GameID and the world index are specified. I assume that the GameID is only needed once at startup to create the world. Only the created world should then be selectable via the world index.

I'll describe the behavior in the README

Tey have native linux bin , then wy are u using a wine image?
and I prefer the {{SERVER_PORT}} no need to parse it first in to a variable

@Attackwave
Copy link
Contributor Author

Same time here...
This night I remembered something about the GameID. I'll test the behavior when the GameID and the world index are specified. I assume that the GameID is only needed once at startup to create the world. Only the created world should then be selectable via the world index.
I'll describe the behavior in the README

Tey have native linux bin , then wy are u using a wine image? and I prefer the {{SERVER_PORT}} no need to parse it first in to a variable

Well, I use Wine because of the pre-installed Xvfb. Haven't found a dedicated Xfvb image and don't know if it's absolutely necessary to create one. Wine is definitely not required.

@Attackwave
Copy link
Contributor Author

Original startup script:
if ! (dpkg -l xvfb >/dev/null) ; then echo "Installing xvfb dependency..." sleep 1 sudo apt-get update -yy && sudo apt-get install xvfb -yy fi

xvfb has quite a few dependencies.

- Variable DATA_PATH (there is no need to set a different directory name)
- Small fixes in startup script
@Attackwave
Copy link
Contributor Author

The Core Keeper Server is "special". Maybe it makes sense to create an Core Keeper Docker file with customized entrypoint and startup script.

@gOOvER
Copy link
Contributor

gOOvER commented Jan 16, 2023

fixes: #1647

@gOOvER
Copy link
Contributor

gOOvER commented Feb 4, 2023

easiest way would be, adding xvfb to steamcmd egg; i know some other games, which also needs xvfb. So no own imgae is needed

@gOOvER
Copy link
Contributor

gOOvER commented Feb 4, 2023

created a PR to add xvfb to the steamcmd image

pelican-eggs/yolks#129

@Nadonate
Copy link

Any update on this?

@gOOvER
Copy link
Contributor

gOOvER commented Mar 13, 2023

Any update on this?

its not merged; so no. Because noone test it

@Attackwave
Copy link
Contributor Author

Sry, hardly found time because of my job.
I'll check the steamcmd image, Xvfb is merged into it.

@QuintenQVD0
Copy link
Collaborator

Sry, hardly found time because of my job. I'll check the steamcmd image, Xvfb is merged into it.

I am already having a look. I can test later

@QuintenQVD0
Copy link
Collaborator

I changed it to:
@Attackwave
please test, else I do it later

{
    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
    "meta": {
        "version": "PTDL_v2",
        "update_url": null
    },
    "exported_at": "2023-03-13T17:15:33+01:00",
    "name": "Core Keeper",
    "author": "karsten@fiedleronline.net",
    "description": "Core Keeper is a survival sandbox game for single or multiplayers.\r\n\r\n--- Drawn towards a mysterious relic, you are an explorer who awakens in an ancient cavern of creatures, resources and trinkets. Trapped deep underground will your survival skills be up to the task? Mine relics and resources to build your base, craft new equipment, survive, and power up the Core. ---",
    "features": [
        "steam_disk_space"
    ],
    "docker_images": {
        "ghcr.io\/parkervcp\/steamcmd:debian": "ghcr.io\/parkervcp\/steamcmd:debian"
    },
    "file_denylist": [],
    "startup": "Xvfb :0 -screen 0 ${DISPLAY_WIDTH}x${DISPLAY_HEIGHT}x${DISPLAY_DEPTH}; rm .\/GameID.txt .\/CoreKeeperServerLog.txt; touch .\/CoreKeeperServerLog.txt; .\/CoreKeeperServer -logfile CoreKeeperServerLog.txt -world {{WORLD_INDEX}} -worldname \"{{WORLD_NAME}}\" -worldseed {{WORLD_SEED}} $([[ \"{{GAME_ID}}\" != \"\" ]] && echo -n \" -gameid \\\"{{GAME_ID}}\\\"\") -maxplayers {{MAX_PLAYERS}} -worldmode {{WORLD_MODE}} -port {{SERVER_PORT}} & CKPID=$!; tail -f CoreKeeperServerLog.txt & LOGPID=$!; trap \"kill $CKPID; wait $CKPID; kill $LOGPID; wait $LOGPID\" 15; wait $!",
    "config": {
        "files": "{}",
        "startup": "{\r\n    \"done\": \"Started server process with pid\"\r\n}",
        "logs": "{}",
        "stop": "^C"
    },
    "scripts": {
        "installation": {
            "script": "#!\/bin\/bash\r\n# steamcmd Base Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n# Image to install with is 'ghcr.io\/parkervcp\/installers:debian'\r\n\r\n##\r\n#\r\n# Variables\r\n# STEAM_USER, STEAM_PASS, STEAM_AUTH - Steam user setup. If a user has 2fa enabled it will most likely fail due to timeout. Leave blank for anon install.\r\n# WINDOWS_INSTALL - if it's a windows server you want to install set to 1\r\n# SRCDS_APPID - steam app id found here - https:\/\/developer.valvesoftware.com\/wiki\/Dedicated_Servers_List\r\n# SRCDS_BETAID - beta branch of a steam app. Leave blank to install normal branch\r\n# SRCDS_BETAPASS - password for a beta branch should one be required during private or closed testing phases.. Leave blank for no password.\r\n# INSTALL_FLAGS - Any additional SteamCMD  flags to pass during install.. Keep in mind that steamcmd auto update process in the docker image might overwrite or ignore these when it performs update on server boot.\r\n# AUTO_UPDATE - Adding this variable to the egg allows disabling or enabling automated updates on boot. Boolean value. 0 to disable and 1 to enable.\r\n#\r\n ##\r\n\r\n# Install packages. Default packages below are not required if using our existing install image thus speeding up the install process.\r\n#apt -y update\r\n#apt -y --no-install-recommends install curl lib32gcc-s1 ca-certificates\r\n\r\n## just in case someone removed the defaults.\r\nif [[ \"${STEAM_USER}\" == \"\" ]] || [[ \"${STEAM_PASS}\" == \"\" ]]; then\r\n    echo -e \"steam user is not set.\\n\"\r\n    echo -e \"Using anonymous user.\\n\"\r\n    STEAM_USER=anonymous\r\n    STEAM_PASS=\"\"\r\n    STEAM_AUTH=\"\"\r\nelse\r\n    echo -e \"user set to ${STEAM_USER}\"\r\nfi\r\n\r\n## download and install steamcmd\r\ncd \/tmp\r\nmkdir -p \/mnt\/server\/steamcmd\r\ncurl -sSL -o steamcmd.tar.gz https:\/\/steamcdn-a.akamaihd.net\/client\/installer\/steamcmd_linux.tar.gz\r\ntar -xzvf steamcmd.tar.gz -C \/mnt\/server\/steamcmd\r\nmkdir -p \/mnt\/server\/steamapps # Fix steamcmd disk write error when this folder is missing\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\nexport HOME=\/mnt\/server\r\n\r\n## install game using steamcmd\r\n.\/steamcmd.sh +force_install_dir \/mnt\/server +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} $( [[ \"${WINDOWS_INSTALL}\" == \"1\" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} validate +quit\r\n\r\n## set up 32 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk32\r\ncp -v linux32\/steamclient.so ..\/.steam\/sdk32\/steamclient.so\r\n\r\n## set up 64 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk64\r\ncp -v linux64\/steamclient.so ..\/.steam\/sdk64\/steamclient.so\r\n\r\n## add below your custom commands if needed\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"",
            "container": "ghcr.io\/parkervcp\/installers:debian",
            "entrypoint": "bash"
        }
    },
    "variables": [
        {
            "name": "World Index",
            "description": "Which world index to use. Default: 0.",
            "env_variable": "WORLD_INDEX",
            "default_value": "0",
            "user_viewable": true,
            "user_editable": true,
            "rules": "required|integer|min:0",
            "field_type": "text"
        },
        {
            "name": "World Name",
            "description": "The name to use for the server. Defaul: Core Keeper Server.",
            "env_variable": "WORLD_NAME",
            "default_value": "Core Keeper Server",
            "user_viewable": true,
            "user_editable": true,
            "rules": "required|string|max:100|min:3",
            "field_type": "text"
        },
        {
            "name": "World Seed",
            "description": "The seed to use for a new world. Set to 0 to generate random seed. Default: 0.",
            "env_variable": "WORLD_SEED",
            "default_value": "0",
            "user_viewable": true,
            "user_editable": true,
            "rules": "required|integer|min:0",
            "field_type": "text"
        },
        {
            "name": "Game ID",
            "description": "Game ID to use for the server. Needs to be at least 28 characters and alphanumeric, excluding Y,y,x,0,O. Empty or not valid means a new ID will be generated at start. Default: EMPTY.",
            "env_variable": "GAME_ID",
            "default_value": "",
            "user_viewable": true,
            "user_editable": true,
            "rules": "nullable|string|min:28",
            "field_type": "text"
        },
        {
            "name": "Max Players",
            "description": "Maximum number of players that will be allowed to connect to server. Maximum is 100. Default: 100,",
            "env_variable": "MAX_PLAYERS",
            "default_value": "100",
            "user_viewable": true,
            "user_editable": true,
            "rules": "required|integer|min:1|max:100",
            "field_type": "text"
        },
        {
            "name": "World Mode",
            "description": "Whether to use normal (0) or hard (1) mode for world.",
            "env_variable": "WORLD_MODE",
            "default_value": "0",
            "user_viewable": true,
            "user_editable": true,
            "rules": "required|boolean",
            "field_type": "text"
        },
        {
            "name": "Steam App ID",
            "description": "Steam App ID of Core Keeper Dedicated Server",
            "env_variable": "SRCDS_APPID",
            "default_value": "1963720",
            "user_viewable": false,
            "user_editable": false,
            "rules": "required|string|in:1963720",
            "field_type": "text"
        },
        {
            "name": "Auto Update",
            "description": "Enable automatic updates on boot",
            "env_variable": "AUTO_UPDATE",
            "default_value": "1",
            "user_viewable": true,
            "user_editable": true,
            "rules": "required|boolean",
            "field_type": "text"
        },
        {
            "name": "DISPLAY_WIDTH",
            "description": "Virtual display width. Fix:1.",
            "env_variable": "DISPLAY_WIDTH",
            "default_value": "1",
            "user_viewable": false,
            "user_editable": false,
            "rules": "required|integer",
            "field_type": "text"
        },
        {
            "name": "DISPLAY_HEIGHT",
            "description": "Virtual display height. Fix:1.",
            "env_variable": "DISPLAY_HEIGHT",
            "default_value": "1",
            "user_viewable": false,
            "user_editable": false,
            "rules": "required|integer",
            "field_type": "text"
        },
        {
            "name": "DISPLAY_DEPTH",
            "description": "Virtual display color depth. Fix: 24.",
            "env_variable": "DISPLAY_DEPTH",
            "default_value": "24",
            "user_viewable": false,
            "user_editable": false,
            "rules": "required|integer",
            "field_type": "text"
        }
    ]
}

@Nadonate
Copy link

Any update on this?

its not merged; so no. Because noone test it

I would happily test!

Just create an egg in panel, and copy/paste the script?

Do i need to enable debug logs somewhere?

@QuintenQVD0
Copy link
Collaborator

eate an egg in pa

just coppy it in to a file and import it as an egg

@Attackwave
Copy link
Contributor Author

Attackwave commented Mar 13, 2023

I changed it to: @Attackwave please test, else I do it later

Installed and testing....

@Attackwave
Copy link
Contributor Author

Attackwave commented Mar 13, 2023

I modified the startup script. Should work now with steamcmd image.

Testing:

  1. Installing: PASS
  2. Startup: PASS
  3. Server marked as started: PASS
  4. Login to server with GameID: PASS
  5. STOP server and marked as offline: PASS

GameID: XXXXXXGermanHellhoundsXXXXXX

@Attackwave Attackwave requested a review from QuintenQVD0 March 13, 2023 19:05
Copy link
Collaborator

@QuintenQVD0 QuintenQVD0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you

@QuintenQVD0 QuintenQVD0 merged commit 7981740 into pelican-eggs:master Mar 13, 2023
@Attackwave Attackwave deleted the CoreKeeper branch March 14, 2023 11:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants