ansible-role-mcs

This is an Ansible role that installs PaperMC or Pufferfish(+) (which are Java versions of Minecraft servers) on systems that are similar to Debian.

Currently, installing plugins and configuring the server are not included.

Installation

Requirements

Add this to your requirements.yml file:

roles:
  - src: simplyvanilla.mcs
    version: main

Role Variables

You can adjust these settings:

# Choose the server fork (paper, pufferfish, pufferfishplus)
mcs_fork: paper

# The version of Minecraft to install
mcs_version: '1.20.1'

# User account to run the server
mcs_user: 'mcs'

# The directory where the server will be installed
mcs_path: '/home/mcs/server'

# Version of Jolokia (used for JMX)
mcs_jolokia_version: '2.0.1'

# Amount of memory allocated to the server (in GB)
mcs_heap: 10

# Time for daily server restarts (format: 'MM HH')
mcs_daily_restart: ''

# Automatically start the service
mcs_autostart: true

# Restart the server if changes are detected
mcs_restart_on_change: true

mcs_pufferfishplus_key: ''

Dependencies

There are no dependencies.

Example Playbook

You can use this example playbook:

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

Usage

To check the status of the server, run this command:

$ sudo systemctl status mcs

License

This project is licensed under the GPLv3.