slime/lazymc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
timvisee
2021-11-10 21:15:45 +01:00
parent cbe35e5585
commit fb8c40e5bb
2 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -4,12 +4,12 @@
players connect. players connect.
Some Minecraft servers (especially modded) use an insane amount of resources Some Minecraft servers (especially modded) use an insane amount of resources
when nobody is playing. lazymc helps by by stopping your server when idle, when nobody is playing. lazymc helps by stopping your server when idle, until a
until a player connects again. player connects again.
lazymc functions as proxy between clients and the server. It handles all lazymc functions as proxy between clients and the server. It handles all
incoming status connections until the server is started and then transparently incoming status connections until the server is started and then transparently
proxies the rest. relays/proxies the rest. All without them noticing.
_Note: this is a prototype and may be incomplete._ _Note: this is a prototype and may be incomplete._
@@ -26,20 +26,32 @@ https://user-images.githubusercontent.com/856222/140804726-ba1a8e59-85d9-413b-82
</p> </p>
</details> </details>
## Features
- Very efficient, lightweight & low-profile (~3KB RAM)
- Supports Minecraft Java Edition 1.6+, supports modded (e.g. Forge, FTB)
- Transparent join: hold clients when server starts, relay when ready, without them noticing
- Customizable MOTD and login messages
- Automatically manages `server.properties` (host, port and RCON settings)
- Graceful server sleep/shutdown through RCON (with `SIGTERM` fallback on Linux/Unix)
- Restart server on crash
## Requirements ## Requirements
- Linux, macOS, Windows - Linux, macOS or Windows
- Minecraft Java Edition 1.6 or above - Minecraft Java Edition 1.6+
- On Windows: RCON (automatically managed by default) - On Windows: RCON (automatically managed)
Using a modded Minecraft server and client (such as Forge) should work fine. _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 ## Usage
Make sure you meet all [requirements](#requirements). Make sure you meet all [requirements](#requirements).
_Note: Installation options are limited at this moment. Read-to-go binaries will _Note: Installation options are limited at this moment. Ready-to-go binaries
be published later. For now we compile and install from source._ will be published later. For now we compile and install from source._
To compile and install you need Rust, install it through `rustup`: https://rustup.rs/ To compile and install you need Rust, install it through `rustup`: https://rustup.rs/

4
res/lazymc.toml
View File

@@ -43,8 +43,8 @@ command = "java -Xmx1G -Xms1G -jar server.jar --nogui"
# Minimum time in seconds to stay online when server is started. # Minimum time in seconds to stay online when server is started.
#minimum_online_time = 60 #minimum_online_time = 60
# Hold client for number of seconds on connect while server starts (instead of kicking immediately). # Hold client for number of seconds on connect while server starts.
# 0 to disable, keep below Minecraft timeout of 30 seconds. # 0 to disable and disconnect immediately, keep below Minecraft timeout of 30 seconds.
#hold_client_for = 25 #hold_client_for = 25
[messages] [messages]