paper-box

Aabernathy Paper docker containers and tools.

Getting Started

After cloning this repository run the following commands for final setup:

git submodule init paper-box-configs
tools/helpers.sh build latest && tools/helpers.sh init

Helpers Tool

For quick and easy management of Aabernathy Paper's ecosystem use the tools/helpers.sh tool. The helpers tool has a number of directives for frequent use commands.

Helpers Commands

• build [tag_name...] | Creates the local images used for running PaperMC services.
• clean | Remove containers and services sub-directory.
• init | Starts initiates Aabernathy Paper's services. Including loading of their configs, plugins and assets.
• start | shortcut to 'docker compose start'.
• stop | shortcut to 'docker compose stop'.
• update_all | Updates service directory configs, plugins and assets and restarts all services.
• update [name] [id...] | Updates service directory configs, plugins and assets then restarts target services.
• sync_config [name] [id...] | rsync shortcut to update configs, plugins and assets.

Install Plugins Tool

For installing plugins required for different environments use the tools/install_plugins.sh tool. Our services are separated, as configured, into different kinds of containers and per kind of server.

Install Plugins Commands

• server [server_type] | Pulls in the required plugin files from their respective remotes. Plugins are pulled into paper-box-configs/<server_type>/plugins/.