residentsleeper/README.md

25 lines
787 B
Markdown

# ResidentSleeper
A plugin-less, mod-less sleep voting system using log parsing, only available on Linux.
## Why
Plugins exist that let you define a certain percentage of users that need to sleep, but they're plugins. They don't work on snapshots/etc.
## How
Log files are generated by the Minecraft server under `logs/latest.log`, which can be read in a fashion similar to `tail -F` to constantly receive updates. Commands are then executed via RCON that's connected using a configuration parser.
## Usage
Requirements: Linux, RCON
Use supervisord or similar to run the program as your Minecraft user, with the flag `-dir /path/to/server`.
The following configuration values are required in server.properties:
```ini
rcon.port=25575
rcon.password=password
enable-rcon=true
```