~timvisee/lazymc

💤 Put your Minecraft server to rest when idle.
37fdb9c1 — Tim Visée 8 months ago
Merge pull request #54 from Spongecade/patch-1
e7a3db19 — Spongecade 8 months ago
Update Minecraft wiki links to new domain
ca475367 — timvisee 10 months ago
Run CI on shared GitLab runners

refs

master
browse  log 
v0.2.10
release notes 

clone

read-only
https://git.sr.ht/~timvisee/lazymc
read/write
git@git.sr.ht:~timvisee/lazymc

You can also use your local clone with git send-email.

Build status on GitLab CI Project license

#lazymc

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

Click to see screenshots

Sleeping server Join sleeping server Starting server Started server

#Features

  • Very efficient, lightweight & low-profile (~3KB RAM)
  • Supports Minecraft Java Edition 1.7.2+, supports modded (e.g. Forge, FTB)
  • Configure joining client occupation methods:
    • Hold: hold clients when server starts, relay when ready, without them noticing
    • Kick: kick clients when server starts, with a starting message
    • Forward: forward client to another IP when server starts
    • Lobby: keep client in emulated server with lobby world, teleport to real server when ready (experimental*)
  • Customizable MOTD and login messages
  • Automatically manages server.properties (host, port and RCON settings)
  • Automatically block banned IPs from server within lazymc
  • Graceful server sleep/shutdown through RCON or SIGTERM
  • Real client IP on Minecraft server with PROXY header (usage)
  • Restart server on crash
  • Lockout mode

#Requirements

  • Linux, macOS or Windows
  • Minecraft Java Edition 1.6+
  • On Windows: RCON (automatically managed)

Build requirements:

  • Rust 1.64 (MSRV)

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.

#Usage

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.

#Compile from source

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

#Third-party usage & implementations

A list of third-party implementations, projects using lazymc, that you might find useful:

#License

This project is released under the GNU GPL-3.0 license. Check out the LICENSE file for more information.