-
Notifications
You must be signed in to change notification settings - Fork 95
Add AutoPlug as egg #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
25f942c
80b6406
b12383f
c01651d
f79706f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # AutoPlug-Client | ||
|
|
||
| AutoPlug-Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. Its main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. While all server types are compatible (including Steam game servers), the majority of its features cater specifically to Minecraft, which is renowned as the world's top-selling game and boasts an exceptionally extensive modding community. | ||
|
|
||
| [AutoPlug-Client GitHub](https://github.com/Osiris-Team/AutoPlug-Client) | ||
| [AutoPlug Website](https://autoplug.one) | ||
|
|
||
| ## Server Ports | ||
|
|
||
| The Minecraft server requires a single port for access (default 25565) but plugins may require extra ports to be enabled for the server. AutoPlug-Client can communicate with websites as well but it shouldn't require any extra ports to be opened. | ||
|
|
||
| | Port | default | | ||
| |-------|---------| | ||
| | Game | 25565 | |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| { | ||
| "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", | ||
| "meta": { | ||
| "version": "PLCN_v1", | ||
| "update_url": "https:\/\/raw.githubusercontent.com\/pelican-eggs\/minecraft\/refs\/heads\/main\/java\/autoplug\/egg-autoplug.json" | ||
| }, | ||
| "exported_at": "2024-09-21T10:42:45+02:00", | ||
| "name": "AutoPlug", | ||
| "author": "[email protected]", | ||
| "uuid": "bb248d17-93e4-4ccc-b085-a40903d29c58", | ||
| "description": "AutoPlug-Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. Its main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. While all server types are compatible (including Steam game servers), the majority of its features cater specifically to Minecraft, which is renowned as the world's top-selling game and boasts an exceptionally extensive modding community.", | ||
| "features": null, | ||
| "docker_images": { | ||
| "Java 21": "ghcr.io\/parkervcp\/yolks:java_21", | ||
| "Java 16": "ghcr.io\/parkervcp\/yolks:java_16", | ||
| "Java 11": "ghcr.io\/parkervcp\/yolks:java_11", | ||
| "Java 8": "ghcr.io\/parkervcp\/yolks:java_8" | ||
| }, | ||
| "file_denylist": [], | ||
| "startup": "java -Xmx128M -Dterminal.jline=false -Dterminal.ansi=true -jar {{SERVER_JARFILE}}", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. set the max ram amount the 95% of the allocated.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I did this on purpose to 128MB, since it is purely a server client before the Minecraft server software. If I set it to 95% and someone has 4GB RAM allocated, it claims that full 4GB RAM for just the client and not the server software launched by the client. |
||
| "config": { | ||
| "files": "{\r\n \"server.properties\": {\r\n \"parser\": \"properties\",\r\n \"find\": {\r\n \"server-ip\": \"0.0.0.0\",\r\n \"server-port\": \"{{server.allocations.default.port}}\",\r\n \"query.port\": \"{{server.allocations.default.port}}\"\r\n }\r\n }\r\n}", | ||
| "startup": "{\r\n \"done\": \")! For help, type \"\r\n}", | ||
| "logs": "{}", | ||
| "stop": ".stb" | ||
| }, | ||
| "scripts": { | ||
| "installation": { | ||
| "script": "#!\/bin\/ash\r\n# AutoPlug Client Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n\r\nmkdir -p \/mnt\/server\r\ncd \/mnt\/server\r\n\r\nDOWNLOAD_URL=\"https:\/\/github.com\/Osiris-Team\/AutoPlug-Releases\/raw\/master\/stable-builds\/AutoPlug-Client.jar\"\r\n\r\necho -e \"running: curl -L -o ${SERVER_JARFILE} $DOWNLOAD_URL\"\r\ncurl -L -o \"${SERVER_JARFILE}\" \"$DOWNLOAD_URL\"\r\n\r\necho -e \"Install Complete\"", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. uset hte git release grab scripts, don''t point it directly at the raw url |
||
| "container": "ghcr.io\/pterodactyl\/installers:alpine", | ||
| "entrypoint": "ash" | ||
| } | ||
| }, | ||
| "variables": [ | ||
| { | ||
| "name": "Minecraft Version", | ||
| "description": "The version of Minecraft to use along with the chosen server software", | ||
| "env_variable": "MINECRAFT_VERSION", | ||
| "default_value": "latest", | ||
| "user_viewable": true, | ||
| "user_editable": true, | ||
| "rules": [ | ||
| "required", | ||
| "alpha_num", | ||
| "between:1,6" | ||
| ], | ||
| "sort": 1 | ||
| }, | ||
| { | ||
| "name": "Server Software", | ||
| "description": "The server software to use along with the AutoPlug client (possible values are: paper, waterfall, travertine, velocity, purpur, fabric, spigot, bungeecord, patina, pufferfish, mirai, pearl, windspigot).", | ||
| "env_variable": "SERVER_SOFTWARE", | ||
| "default_value": "paper", | ||
| "user_viewable": true, | ||
| "user_editable": true, | ||
| "rules": [ | ||
| "required", | ||
| "string", | ||
| "max:10" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the valutes are limited so use |
||
| ], | ||
| "sort": 2 | ||
| }, | ||
| { | ||
| "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": false, | ||
| "user_editable": false, | ||
| "rules": [ | ||
| "required", | ||
| "regex:\/^([\\w\\d._-]+)(\\.jar)$\/" | ||
| ], | ||
| "sort": 3 | ||
| } | ||
| ] | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| { | ||
| "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", | ||
| "meta": { | ||
| "version": "PTDL_v2", | ||
| "update_url": null | ||
| }, | ||
| "exported_at": "2024-09-21T10:42:45+02:00", | ||
| "name": "AutoPlug", | ||
| "author": "[email protected]", | ||
| "description": "AutoPlug-Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. Its main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. While all server types are compatible (including Steam game servers), the majority of its features cater specifically to Minecraft, which is renowned as the world's top-selling game and boasts an exceptionally extensive modding community.", | ||
| "features": null, | ||
| "docker_images": { | ||
| "Java 21": "ghcr.io\/pterodactyl\/yolks:java_21", | ||
| "Java 16": "ghcr.io\/pterodactyl\/yolks:java_16", | ||
| "Java 11": "ghcr.io\/pterodactyl\/yolks:java_11", | ||
| "Java 8": "ghcr.io\/pterodactyl\/yolks:java_8" | ||
| }, | ||
| "file_denylist": [], | ||
| "startup": "java -Xmx128M -Dterminal.jline=false -Dterminal.ansi=true -jar {{SERVER_JARFILE}}", | ||
| "config": { | ||
| "files": "{\r\n \"server.properties\": {\r\n \"parser\": \"properties\",\r\n \"find\": {\r\n \"server-ip\": \"0.0.0.0\",\r\n \"server-port\": \"{{server.build.default.port}}\",\r\n \"query.port\": \"{{server.build.default.port}}\"\r\n }\r\n }\r\n}", | ||
| "startup": "{\r\n \"done\": \")! For help, type \"\r\n}", | ||
| "logs": "{}", | ||
| "stop": ".stb" | ||
| }, | ||
| "scripts": { | ||
| "installation": { | ||
| "script": "#!\/bin\/ash\r\n# AutoPlug Client Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n\r\nmkdir -p \/mnt\/server\r\ncd \/mnt\/server\r\n\r\nDOWNLOAD_URL=\"https:\/\/github.com\/Osiris-Team\/AutoPlug-Releases\/raw\/master\/stable-builds\/AutoPlug-Client.jar\"\r\n\r\necho -e \"running: curl -L -o ${SERVER_JARFILE} $DOWNLOAD_URL\"\r\ncurl -L -o \"${SERVER_JARFILE}\" \"$DOWNLOAD_URL\"\r\n\r\necho -e \"Install Complete\"", | ||
| "container": "ghcr.io\/pterodactyl\/installers:alpine", | ||
| "entrypoint": "ash" | ||
| } | ||
| }, | ||
| "variables": [ | ||
| { | ||
| "name": "Minecraft Version", | ||
| "description": "The version of Minecraft to use along with the chosen server software", | ||
| "env_variable": "MINECRAFT_VERSION", | ||
| "default_value": "latest", | ||
| "user_viewable": true, | ||
| "user_editable": true, | ||
| "rules": "required|alpha_num|between:1,6", | ||
| "field_type": "text" | ||
| }, | ||
| { | ||
| "name": "Server Software", | ||
| "description": "The server software to use along with the AutoPlug client (possible values are: paper, waterfall, travertine, velocity, purpur, fabric, spigot, bungeecord, patina, pufferfish, mirai, pearl, windspigot).", | ||
| "env_variable": "SERVER_SOFTWARE", | ||
| "default_value": "paper", | ||
| "user_viewable": true, | ||
| "user_editable": true, | ||
| "rules": "required|string|max:10", | ||
| "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": false, | ||
| "user_editable": false, | ||
| "rules": "required|regex:\/^([\\w\\d._-]+)(\\.jar)$\/", | ||
| "field_type": "text" | ||
| } | ||
| ] | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doesn't this need the EULA?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if you'd want this here since it's not the server software itself (gets launched afterwards, this client is to provide stuff like upgrading plugins prior to launching the final server software), unless you think it's necessary here as well.