Skip to content
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

Add egg-pterodactyl-autoplug #28

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions java/autoplug/README.md
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 |
65 changes: 65 additions & 0 deletions java/autoplug/egg-pterodactyl-autoplug.json
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"
}
]
}