Skip to content

Ansible role that installs PaperMC or Pufferfish(+), Minecraft Server Java forks, on Debian-like systems.

License

Notifications You must be signed in to change notification settings

SimplyVanilla/ansible-role-mcs

Repository files navigation

ansible-role-mcs

CircleCI

Ansible role that installs PaperMC or Pufferfish(+) (Minecraft Server Java forks) on Debian-like systems.

Plugin installation as well as server configuration is currently out-of-scope.

Installation

Requirements

In your requirements.yml:

roles:
  - src: simplyvanilla.mcs
    version: main

Role Variables

# Fork to use (paper, pufferfish, pufferfishplus
mcs_fork: paper

# Minecraft release to install
mcs_version: '1.20.1'

# User to run server as
mcs_user: 'mcs'

# Installation path / working directory
mcs_path: '/home/mcs/server'

# Jolokia version (JMX gateway)
mcs_jolokia_version: '2.0.1'

# JVM Heap size in GB
mcs_heap: 10

# set 'MM HH' of when daily restarts should occur
mcs_daily_restart: ''

# enable service
mcs_autostart: true

# restart on detected change
mcs_restart_on_change: true

mcs_pufferfishplus_key: ''

Dependencies

none

Example Playbook

- hosts: servers
  tasks:
    - ansible.builtin.import_role:
        name: simplyvanilla.mcs

Usage

$ sudo systemctl status mcs

License

GPLv3