Cleanup documentation

This commit is contained in:
timvisee 2021-11-25 13:42:57 +01:00
parent e7d2c6f64c
commit 40fe5b5dd2
No known key found for this signature in database
GPG Key ID: B8DB720BC383E172
7 changed files with 13 additions and 11 deletions

View File

@ -43,7 +43,7 @@ https://user-images.githubusercontent.com/856222/141378688-882082be-9efa-4cfe-81
- _Lobby: keep client in emulated server with lobby world, teleport to real server when ready ([experimental*](./docs/join-method-lobby.md))_ - _Lobby: keep client in emulated server with lobby world, teleport to real server when ready ([experimental*](./docs/join-method-lobby.md))_
- Customizable MOTD and login messages - Customizable MOTD and login messages
- Automatically manages `server.properties` (host, port and RCON settings) - Automatically manages `server.properties` (host, port and RCON settings)
- Automatically block banned IPs from server within `lazymc` - Automatically block banned IPs from server within lazymc
- Graceful server sleep/shutdown through RCON or `SIGTERM` - Graceful server sleep/shutdown through RCON or `SIGTERM`
- Real client IP on Minecraft server with `PROXY` header ([usage](./docs/proxy-ip.md)) - Real client IP on Minecraft server with `PROXY` header ([usage](./docs/proxy-ip.md))
- Restart server on crash - Restart server on crash
@ -77,8 +77,8 @@ chmod a+x ./lazymc
./lazymc --help ./lazymc --help
``` ```
When `lazymc` is set-up, change into your server directory if you haven't When lazymc is set-up, change into your server directory if you haven't already.
already. Then set up the [configuration](./res/lazymc.toml) and start it up: Then set up the [configuration](./res/lazymc.toml) and start it up:
```bash ```bash
# Change into your server directory (if you haven't already) # Change into your server directory (if you haven't already)
@ -140,7 +140,7 @@ cargo build --release
## Third-party usage & implementations ## Third-party usage & implementations
A list of third-party implementations, projects using `lazymc`, that you might A list of third-party implementations, projects using lazymc, that you might
find useful: find useful:
- Docker: [crbanman/papermc-lazymc](https://hub.docker.com/r/crbanman/papermc-lazymc) _(PaperMC with lazymc in Docker)_ - Docker: [crbanman/papermc-lazymc](https://hub.docker.com/r/crbanman/papermc-lazymc) _(PaperMC with lazymc in Docker)_

View File

@ -4,7 +4,7 @@ You may use a `bash` script to start your server rather than invoking `java`
directly. This requires some changes though to ensure your server properly shuts directly. This requires some changes though to ensure your server properly shuts
down. down.
When `lazymc` stops your server it sends a [`SIGTERM`][sigterm] signal to the When lazymc stops your server it sends a [`SIGTERM`][sigterm] signal to the
invoked server process to gracefully shut it down. `bash` ignores this signal by invoked server process to gracefully shut it down. `bash` ignores this signal by
default and keeps the Minecraft server running. default and keeps the Minecraft server running.

View File

@ -3,7 +3,7 @@
Some extra steps and recommendations when using lazymc: Some extra steps and recommendations when using lazymc:
Before you use this in production, always ensure starting and stopping the 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 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 it starts and stops. If stopping results in errors, fix this first to prevent
corrupting world/user data. corrupting world/user data.

View File

@ -7,7 +7,7 @@ The lobby join method allows you to keep clients in a lobby world while the
server is starting. When the server is ready, the player is _teleported_ to the server is starting. When the server is ready, the player is _teleported_ to the
real server. real server.
`lazymc` emulates a fake server with an empty lobby world. The player is put in lazymc emulates a fake server with an empty lobby world. The player is put in
this world, floating in space. A custom message is shown on the client to notify this world, floating in space. A custom message is shown on the client to notify
we're waiting on the server to start. we're waiting on the server to start.

View File

@ -10,7 +10,7 @@ gets a new protocol version.
## Configuration ## Configuration
In `lazymc` you may configure what protocol version to use: In lazymc you may configure what protocol version to use:
[`lazymc.toml`](../res/lazymc.toml): [`lazymc.toml`](../res/lazymc.toml):
@ -35,5 +35,5 @@ allow the best compatibility with clients.
- Set `public.version` to any string you like. Shows up in read in clients that - Set `public.version` to any string you like. Shows up in read in clients that
have an incompatibel protocol version number have an incompatibel protocol version number
These are used as hint. `lazymc` will automatically use the protocol version of These are used as hint. lazymc will automatically use the protocol version of
your Minecraft server once it has started at least once. your Minecraft server once it has started at least once.

View File

@ -14,8 +14,8 @@ Open a terminal, go to the server directory, and make sure you can execute it:
.\lazymc --help .\lazymc --help
``` ```
When `lazymc` is ready, set up the [configuration](./res/lazymc.toml) and start When lazymc is ready, set up the [configuration](./res/lazymc.toml) and start it
it up: up:
```bash ```bash
# In your Minecraft server directory: # In your Minecraft server directory:

View File

@ -1,5 +1,7 @@
#!/bin/bash #!/bin/bash
# See: https://git.io/JMIKH
# Server JAR file, set this to your own # Server JAR file, set this to your own
FILE=server.jar FILE=server.jar