diff --git a/README.md b/README.md index 2a82620..30ef1a4 100644 --- a/README.md +++ b/README.md @@ -94,20 +94,14 @@ nano lazymc.toml lazymc start ``` -Before you use this in production, please ensure starting and stopping the -server works as expected by connecting to it once. Watch `lazymc`s output while -it starts and stops. If stopping results in errors, fix this first to prevent -corrupting world/user data. +Please see [extras](./docs/extras.md) for recommendations and additional things +to set up (e.g. how to fix incorrect client IPs and IP banning on your server). -Follow this repository with the _Watch_ button on the top right to be notified of new releases. - -Everything should now be ready to go! Connect with your Minecraft client to wake -your server up! +After you've read through the [extras](./docs/extras.md), 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](#compile-from-source)._ - -_Note: Installation options are limited at this moment. More will be added +source](#compile-from-source). Installation options are limited at this moment. More will be added later._ [latest-release]: https://github.com/timvisee/lazymc/releases/latest diff --git a/docs/extras.md b/docs/extras.md new file mode 100644 index 0000000..dbe0f46 --- /dev/null +++ b/docs/extras.md @@ -0,0 +1,28 @@ +# Extras + +Some extra steps and recommendations when using lazymc: + +Before you use this in production, always ensure starting and stopping the +server works as expected by connecting to it once. Watch `lazymc`s output while +it starts and stops. If stopping results in errors, fix this first to prevent +corrupting world/user data. + +Follow this repository with the _Watch_ button on the top right to be notified +of new releases. + +## Recommended + +- [Protocol version](./protocol-version.md): + _set correct Minecraft protocol version for the best client compatability_ +- [Proxy IP](./proxy-ip.md): + _fix incorrect client IPs on Minecraft server, notify server of correct IP with `PROXY` header_ + +## Tips + +- [bash with start command](./command_bash.md): + _how to properly use a bash script as server start command_ + +## Experimental features + +- [Join method: lobby](./join-method-lobby.md): + _keep clients in fake lobby world while server starts, teleport to real server when ready_ diff --git a/docs/proxy-ip.md b/docs/proxy-ip.md index 2344554..8aa1322 100644 --- a/docs/proxy-ip.md +++ b/docs/proxy-ip.md @@ -1,7 +1,7 @@ # Proxy IP lazymc acts as a proxy most of the time. Because of this the Minecraft server -will think all clients connect from the same IP, being the IP `lazymc` proxies +will think all clients connect from the same IP, being the IP lazymc proxies from. This breaks IP banning (`/ban-ip`, amongst other IP related things). This may be @@ -49,7 +49,8 @@ Other related properties, you probably won't need to touch, include: ## Server plugin Install one of these plugins as companion on your server to enable support for -the `PROXY` header. +the `PROXY` header. This requires Minecraft server software supporting plugins, +the vanilla Minecraft server does not support this. If lazymc connects to a Spigot compatible server, use any of: diff --git a/docs/usage-windows.md b/docs/usage-windows.md index 965b6fa..0a8c348 100644 --- a/docs/usage-windows.md +++ b/docs/usage-windows.md @@ -31,15 +31,11 @@ notepad lazymc.toml .\lazymc start ``` -Before you use this in production, please ensure starting and stopping the -server works as expected by connecting to it once. Watch `lazymc`s output while -it starts and stops. If stopping results in errors, fix this first to prevent -corrupting world/user data. +Please see [extras](./extras.md) for recommendations and additional things +to set up (e.g. how to fix incorrect client IPs and IP banning on your server). -Follow this repository with the _Watch_ button on the top right to be notified of new releases. - -Everything should now be ready to go! Connect with your Minecraft client to wake -your server up! +After you've read through the [extras](./extras.md), everything should now +be ready to go! Connect with your Minecraft client to wake your server up! _Note: if you put `lazymc` in `PATH`, or if you [install](../README.md#compile-from-source) it through Cargo, you can invoke