Merge pull request #54 from Spongecade/patch-1
Update Minecraft wiki links to new domain
Run CI on shared GitLab runners
lazymc
puts your Minecraft server to rest when idle, and wakes it up when
players connect.
Some Minecraft servers (especially modded) use an insane amount of resources when nobody is playing. lazymc helps by stopping your server when idle, until a player connects again.
lazymc functions as proxy between clients and the server. It handles all incoming status connections until the server is started and then transparently relays/proxies the rest. All without them noticing.
https://user-images.githubusercontent.com/856222/141378688-882082be-9efa-4cfe-81cc-5a7ab8b8e86b.mp4
server.properties
(host, port and RCON settings)SIGTERM
PROXY
header (usage)Build requirements:
Note: You must have access to the system to run the lazymc
binary. If you're
using a Minecraft shared hosting provider with a custom dashboard, you likely
won't be able to set this up.
Note: these instructions are for Linux & macOS, for Windows look here.
Make sure you meet all requirements.
Download the appropriate binary for your system from the latest release page. On macOS you must compile from source.
Place the binary in your Minecraft server directory, rename it if you like. Open a terminal, go to the directory, and make sure you can invoke it:
chmod a+x ./lazymc
./lazymc --help
When lazymc is set-up, change into your server directory if you haven't already. Then set up the configuration and start it up:
# Change into your server directory (if you haven't already)
cd server
# Generate lazymc configuration
lazymc config generate
# Edit configuration
# Set the correct server address, directory and start command
nano lazymc.toml
# Start lazymc
lazymc start
Please see extras for recommendations and additional things to set up (e.g. how to fix incorrect client IPs and IP banning on your server).
After you've read through the extras, everything should now be ready to go! Connect with your Minecraft client to wake your server up!
Note: If a binary for your system isn't provided, please compile from source. Installation options are limited at this moment. More will be added later.
Make sure you meet all requirements.
To compile from source you need Rust, install it through rustup
: https://rustup.rs/
When Rust is installed, compile and install lazymc
from this git repository
directly:
# Compile and install lazymc from source
cargo install -f --git https://github.com/timvisee/lazymc
# Ensure lazymc works
lazymc --help
Or clone the repository and build it yourself:
# Clone repository
git clone https://github.com/timvisee/lazymc
cd lazymc
# Compile
cargo build --release
# Run lazymc
./target/release/lazymc --help
A list of third-party implementations, projects using lazymc, that you might find useful:
This project is released under the GNU GPL-3.0 license. Check out the LICENSE file for more information.