Retards Server configuration

This repository contains the configuration files for the Retards Server.
It has everything needed to deploy an exact copy of the server, minus world and player data.
It also contains tools and helpers for testing and for faster management.

Structure

The repository is structured as follows:

• conf/: contains a few modularized configuration files, such as the environment variables used by the server and the list of plugins to install.
  It's mounted into /conf to be used by the MODRINTH_PROJECTS and PLUGINS_FILE environment variables.
• plugins/: contains the configurations to apply for all plugins on startup.
  It's mounted into /plugins. The itzg/minecraft-server image automatically copies the contents of this directory into the server's plugin directory on boot.
• scripts/: contains a few helper scripts for managing the server.
• test/: contains a separate compose.yml file configured to use the same settings as the production server, except for performance settings, such as 2GB of max memory rather than 10.

conf/

This directory contains the following configuration files:

• prod.env: contains the environment variables passed to the production server. These are env vars used by the itzg/minecraft-server image.
• test.env: contains the environment variables passed to the test server. They differ from prod.env in that they are optimized for testing, with lower memory usage, render distance and player count.
• modrinth-projects.conf: contains the list of Modrinth projects to install on the server. Plugins are listed line-by-line by their Modrinth ID, eventually prefixed with datapack: to indicate that its datapack version should be installed.
  The server will automatically install the latest version of all plugins listed in this file on startup.
• plugins.conf: contains a list of direct URLs to plugin JARs to install.

Note

prod.env and test.env also contain a SPIGET_RESOURCES variable set to install the Vault plugin.

just commands

The repo is configured with a justfile and a few helper commands to make server management easier.

The following are all the available commands:

• just start
  Starts the server.
• just stop
  Stops the server.
• just restart
  Restarts the server.
• just attach
  Attaches to the server's console.
• just cmd <command>
  Runs a command on the server through rcon-cli.

  Warning

  This command runs rcon-cli through a bash shell, which may mess up with a few special characters, such as { or ". When in doubt, wrap the whole command in single quotes ('). Also, a few plugins, such as LuckPerms, seem to not perform any action or output when their commands are executed through this method. Therefore, to run commands such as lp editor, attach to the console instead.

• just list
  Lists online players in the server.
• just say
  Sends a message to all online players.
• just title
just title-red
just title-green
  Shows a title to all online players.
• just title-clear
  Clears the title from all online players.
• just db-factions
  Opens up a custom SQL shell for PvPIndex-Factions' H2 database. Do note that it requires the server to be offline in order to work.

plugins/

This directory contains the custom configurations applied to plugins on startup.
Most configuration files begin with a comment containing the URL of the plugin's documentation.

LuckPerms

LuckPerms requires special care when used. It's configured to use YAML-based storage, and all permissions are overridden by the ones stored in plugins/LuckPerms/yaml-storage/ on each startup. As such, simply editing permissions through commands or lp editor will not persist across server restarts. Make sure to copy the contents of data/plugins/LuckPerms/yaml-storage/* to plugins/LuckPerms/yaml-storage/ before starting the server.