diff --git a/README.md b/README.md index cc1504d7..18a0d59e 100644 --- a/README.md +++ b/README.md @@ -186,6 +186,7 @@ If you are reading this it looks like you are looking to add an egg to your serv * [Travertine](game_eggs/minecraft/proxy/java/travertine) * [Velocity](game_eggs/minecraft/proxy/java/velocity) * [Waterfall](game_eggs/minecraft/proxy/java/waterfall) + * [MCDReforged](game_eggs/minecraft/proxy/java/mcdreforged) * [Bedrock](game_eggs/minecraft/proxy/bedrock) * [Waterdog PE](game_eggs/minecraft/proxy/bedrock/waterdog_pe) * [Cross Platform](game_eggs/minecraft/proxy/cross_platform) diff --git a/game_eggs/minecraft/proxy/java/mcdreforged/README.MD b/game_eggs/minecraft/proxy/java/mcdreforged/README.MD new file mode 100644 index 00000000..94eadeb3 --- /dev/null +++ b/game_eggs/minecraft/proxy/java/mcdreforged/README.MD @@ -0,0 +1,18 @@ +# MCDReforged + +MCDReforged (abbreviated as MCDR) is a tool which provides the management ability of the Minecraft server using custom plugin system. It doesn't need to modify or mod the original Minecraft server at all + +[MCDReforged Github](https://github.com/Fallen-Breath/MCDReforged) +[MCDReforged Wiki](https://mcdreforged.readthedocs.io/) + +## 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 | + +## declaration + +The script part refers to paper Egg, because only MCDReforged cannot be used normally, and a server is required. diff --git a/game_eggs/minecraft/proxy/java/mcdreforged/egg-m-c-d-reforged.json b/game_eggs/minecraft/proxy/java/mcdreforged/egg-m-c-d-reforged.json new file mode 100644 index 00000000..2a801a7a --- /dev/null +++ b/game_eggs/minecraft/proxy/java/mcdreforged/egg-m-c-d-reforged.json @@ -0,0 +1,115 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2023-02-07T16:11:09+08:00", + "name": "MCDReforged", + "author": "vlssu@vlssu.com", + "description": "MCDReforged (abbreviated as MCDR) is a tool which provides the management ability of the Minecraft server using custom plugin system. It doesn't need to modify or mod the original Minecraft server at all", + "features": null, + "docker_images": { + "MCDR_java8": "ghcr.io\/parkervcp\/games:mcdr_java_8", + "MCDR_java11": "ghcr.io\/parkervcp\/games:mcdr_java_11", + "MCDR_java16": "ghcr.io\/parkervcp\/games:mcdr_java_16", + "MCDR_java17": "ghcr.io\/parkervcp\/games:mcdr_java_17" + }, + "file_denylist": [], + "startup": "python -m mcdreforged", + "config": { + "files": "{\r\n \"config.yml\": {\r\n \"parser\": \"yml\",\r\n \"find\": {\r\n \"language\": \"{{server.build.env.default_language}}\",\r\n \"start_command\": \"java -XX:MaxRAMPercentage=95.0 {{server.build.env.EXTRA_PARAMETERS}} -Dterminal.jline=false -Dterminal.ansi=true -jar {{server.build.env.SERVER_JARFILE}} nogui\",\r\n \"handler\": \"{{server.build.env.server_handler}}\"\r\n }\r\n },\r\n \"server\/server.properties\": {\r\n \"parser\": \"properties\",\r\n \"find\": {\r\n \"server-ip\": \"0.0.0.0\",\r\n \"enable-query\": \"true\",\r\n \"server-port\": \"{{server.build.default.port}}\",\r\n \"query.port\": \"{{server.build.default.port}}\"\r\n }\r\n },\r\n \"server\/eula.txt\": {\r\n \"parser\": \"properties\",\r\n \"find\": {\r\n \"eula\": \"{{server.build.env.EULA}}\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \")! For help, type \"\r\n}", + "logs": "{}", + "stop": "stop" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/ash\r\n# Paper Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\nPROJECT=paper\r\n\r\nif [ -n \"${DL_PATH}\" ]; then\r\n\techo -e \"Using supplied download url: ${DL_PATH}\"\r\n\tDOWNLOAD_URL=`eval echo $(echo ${DL_PATH} | sed -e 's\/{{\/${\/g' -e 's\/}}\/}\/g')`\r\nelse\r\n\tVER_EXISTS=`curl -s https:\/\/papermc.io\/api\/v2\/projects\/${PROJECT} | jq -r --arg VERSION $MINECRAFT_VERSION '.versions[] | contains($VERSION)' | grep true`\r\n\tLATEST_VERSION=`curl -s https:\/\/papermc.io\/api\/v2\/projects\/${PROJECT} | jq -r '.versions' | jq -r '.[-1]'`\r\n\r\n\tif [ \"${VER_EXISTS}\" == \"true\" ]; then\r\n\t\techo -e \"Version is valid. Using version ${MINECRAFT_VERSION}\"\r\n\telse\r\n\t\techo -e \"Using the latest ${PROJECT} version\"\r\n\t\tMINECRAFT_VERSION=${LATEST_VERSION}\r\n\tfi\r\n\t\r\n\tBUILD_EXISTS=`curl -s https:\/\/papermc.io\/api\/v2\/projects\/${PROJECT}\/versions\/${MINECRAFT_VERSION} | jq -r --arg BUILD ${BUILD_NUMBER} '.builds[] | tostring | contains($BUILD)' | grep true`\r\n\tLATEST_BUILD=`curl -s https:\/\/papermc.io\/api\/v2\/projects\/${PROJECT}\/versions\/${MINECRAFT_VERSION} | jq -r '.builds' | jq -r '.[-1]'`\r\n\t\r\n\tif [ \"${BUILD_EXISTS}\" == \"true\" ]; then\r\n\t\techo -e \"Build is valid for version ${MINECRAFT_VERSION}. Using build ${BUILD_NUMBER}\"\r\n\telse\r\n\t\techo -e \"Using the latest ${PROJECT} build for version ${MINECRAFT_VERSION}\"\r\n\t\tBUILD_NUMBER=${LATEST_BUILD}\r\n\tfi\r\n\t\r\n\tJAR_NAME=${PROJECT}-${MINECRAFT_VERSION}-${BUILD_NUMBER}.jar\r\n\t\r\n\techo \"Version being downloaded\"\r\n\techo -e \"MC Version: ${MINECRAFT_VERSION}\"\r\n\techo -e \"Build: ${BUILD_NUMBER}\"\r\n\techo -e \"JAR Name of Build: ${JAR_NAME}\"\r\n\tDOWNLOAD_URL=https:\/\/papermc.io\/api\/v2\/projects\/${PROJECT}\/versions\/${MINECRAFT_VERSION}\/builds\/${BUILD_NUMBER}\/downloads\/${JAR_NAME}\r\nfi\r\n\r\ncd \/mnt\/server\/server\r\n\r\necho -e \"Running curl -o ${SERVER_JARFILE} ${DOWNLOAD_URL}\"\r\n\r\nif [ -f ${SERVER_JARFILE} ]; then\r\n\tmv ${SERVER_JARFILE} ${SERVER_JARFILE}.old\r\nfi\r\n\r\ncurl -o ${SERVER_JARFILE} ${DOWNLOAD_URL}\r\n\r\nif [ ! -f server.properties ]; then\r\n echo -e \"Downloading MC server.properties\"\r\n curl -o server.properties https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/minecraft\/java\/server.properties\r\nfi", + "container": "registry.cn-shanghai.aliyuncs.com\/pterodactyl-images\/yolks:mcdr_java_17", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Minecraft Version", + "description": "The version of minecraft to download. \r\n\r\nLeave at latest to always get the latest version. Invalid versions will default to latest.", + "env_variable": "MINECRAFT_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Server Jar File", + "description": "The name of the server jarfile to run the server with.", + "env_variable": "SERVER_JARFILE", + "default_value": "server.jar", + "user_viewable": true, + "user_editable": true, + "rules": "required|regex:\/^([\\w\\d._-]+)(\\.jar)$\/", + "field_type": "text" + }, + { + "name": "Download Path", + "description": "A URL to use to download a server.jar rather than the ones in the install script. This is not user viewable.", + "env_variable": "DL_PATH", + "default_value": "", + "user_viewable": false, + "user_editable": false, + "rules": "nullable|string", + "field_type": "text" + }, + { + "name": "Build Number", + "description": "The build number for the paper release.\r\n\r\nLeave at latest to always get the latest version. Invalid versions will default to latest.", + "env_variable": "BUILD_NUMBER", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "MCDReforged language", + "description": "", + "env_variable": "default_language", + "default_value": "en_us", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:zh_cn,en_us", + "field_type": "text" + }, + { + "name": "Compatible server types", + "description": "Please refer to the document for detailed settings:\r\nhttps:\/\/mcdreforged.readthedocs.io\/en\/latest\/configuration.html#handler", + "env_variable": "server_handler", + "default_value": "bukkit_handler", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:vanilla_handler,beta18_handler,bukkit_handler,bukkit14_handler,forge_handler,cat_server_handler,bungeecord_handler,velocity_handler", + "field_type": "text" + }, + { + "name": "Additional parameters", + "description": "", + "env_variable": "EXTRA_PARAMETERS", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + }, + { + "name": "EULA", + "description": "Whether to agree to the EULA agreement, agree by default.", + "env_variable": "EULA", + "default_value": "true", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:false,true", + "field_type": "text" + } + ] +} \ No newline at end of file