{"id":15174350,"url":"https://github.com/atomicsponge/paper-systemd","last_synced_at":"2026-02-26T16:38:22.149Z","repository":{"id":247418992,"uuid":"825392656","full_name":"AtomicSponge/paper-systemd","owner":"AtomicSponge","description":"Control Paper Minecraft server with systemd","archived":false,"fork":false,"pushed_at":"2024-12-04T20:39:37.000Z","size":37,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-01T11:09:48.137Z","etag":null,"topics":["linux","minecraft","minecraft-server","minecraft-server-management","papermc","script","server","systemd","systemd-service"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AtomicSponge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-07T16:37:08.000Z","updated_at":"2024-12-25T22:51:52.000Z","dependencies_parsed_at":"2024-09-23T05:01:45.180Z","dependency_job_id":"8df5f70a-3f5c-445d-8407-4da76af790f4","html_url":"https://github.com/AtomicSponge/paper-systemd","commit_stats":{"total_commits":42,"total_committers":1,"mean_commits":42.0,"dds":0.0,"last_synced_commit":"5030c9d381fddc0cf059a8aa2016a543107a2866"},"previous_names":["atomicsponge/paper-systemd"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtomicSponge%2Fpaper-systemd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtomicSponge%2Fpaper-systemd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtomicSponge%2Fpaper-systemd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtomicSponge%2Fpaper-systemd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AtomicSponge","download_url":"https://codeload.github.com/AtomicSponge/paper-systemd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239985689,"owners_count":19729512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linux","minecraft","minecraft-server","minecraft-server-management","papermc","script","server","systemd","systemd-service"],"created_at":"2024-09-27T12:00:22.193Z","updated_at":"2025-11-11T16:02:11.940Z","avatar_url":"https://github.com/AtomicSponge.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Paper MC systemd scripts\n\nSteps for using the provided scripts and setting up the __Paper MC__ server as a __systemd__ service.  This will allow you to control the server with `systemctl` and interact with it using the `minecraft` command.\n\n-----\n\n## Create Service Account\n\nCreate a user account named `minecraft`.  This will be the service account for running the server.\n```\nsudo useradd -m -r minecraft\nsudo passwd minecraft\n```\n\n## Download Paper MC\n\nLog into the minecraft service account.  Download __Paper__ server from:\n\u003chttps://papermc.io/software/paper\u003e\n\nPlace the server in `/home/minecraft/paper` then rename the __Paper__ server executable file to `server.jar`.\n\nUsing the commands below, replacing for the correct download URL and filename:\n```\nmkdir paper\ncd paper\nwget https://api.papermc.io/v2/projects/paper/GETLATESTFROMWEBSITE\nmv paper-x.xx.x-xxx.jar server.jar\n```\n\n*Note:* If this is the first time you're running __Paper__ on your server, you'll want to manually run it at this point to agree to its EULA.\n\nRun:\n```\njava -Xms4G -Xmx4G -jar server.jar --nogui\n```\nAnd follow the on screen prompts.\n\n## Configure scripts\n\nSwitch back to your primary account with __sudo__ access.\n\nClone this repo:\n```\ngit clone https://github.com/AtomicSponge/paper-systemd.git\ncd paper-systemd\n```\n\nCreate link of file `minecraft-console.py` in `/usr/local/bin` and make sure it has execute permissions by running:\n```\nchmod 555 minecraft-console.py\nsudo ln minecraft-console.py /usr/local/bin\n```\n\nPlace files `minecraft.service` and `minecraft.socket` in `/etc/systemd/system`:\n```\nsudo mv minecraft.service /etc/systemd/system\nsudo mv minecraft.socket /etc/systemd/system\n```\n\nThen to start the service run:\n```\nsudo systemctl enable minecraft\n```\n\n## Memory Setting\n\nDefault memory setting is 4GB, to change edit `minecraft_java.env` and update `JAVA_OPTS` to your desired values::\n```\n-Xms4096M -Xmx4096M\n```\n\n## Usage\n\nCommands are passed to the server via the provided script `minecraft-console.py`.\n\nTo run commands, open console by running `minecraft-console`. \n\nAfter executing the command, you will see the server log from `journalctl` and a prompt to enter the command.\n\nTo exit the console, press CTRL+C\n\n\u003csub\u003e*Note:* Do not use / before the command name\u003c/sub\u003e\n\nTo view server output use the `journalctl` command.\n\nFor example, this will monitor the log:\n```\njournalctl -u minecraft -f\n```\n\n-----\n\n### References\n\nFor a list of server commands see:\n\u003chttps://minecraft.fandom.com/wiki/Commands\u003e\n\nService script is using the Aikar's flags from:\n\u003chttps://docs.papermc.io/misc/tools/start-script-gen\u003e\n\n`journalctl` manual:\n\u003chttps://www.freedesktop.org/software/systemd/man/latest/journalctl.html#\u003e\n\nAdapted from:\n\u003chttps://unix.stackexchange.com/a/612118\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomicsponge%2Fpaper-systemd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatomicsponge%2Fpaper-systemd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomicsponge%2Fpaper-systemd/lists"}