Cleanup documentation
This commit is contained in:
parent
e7d2c6f64c
commit
40fe5b5dd2
@ -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))_
|
||||
- Customizable MOTD and login messages
|
||||
- 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`
|
||||
- Real client IP on Minecraft server with `PROXY` header ([usage](./docs/proxy-ip.md))
|
||||
- Restart server on crash
|
||||
@ -77,8 +77,8 @@ 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](./res/lazymc.toml) and start it up:
|
||||
When lazymc is set-up, change into your server directory if you haven't already.
|
||||
Then set up the [configuration](./res/lazymc.toml) and start it up:
|
||||
|
||||
```bash
|
||||
# Change into your server directory (if you haven't already)
|
||||
@ -140,7 +140,7 @@ cargo build --release
|
||||
|
||||
## 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:
|
||||
|
||||
- Docker: [crbanman/papermc-lazymc](https://hub.docker.com/r/crbanman/papermc-lazymc) _(PaperMC with lazymc in Docker)_
|
||||
|
@ -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
|
||||
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
|
||||
default and keeps the Minecraft server running.
|
||||
|
||||
|
@ -3,7 +3,7 @@
|
||||
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
|
||||
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.
|
||||
|
||||
|
@ -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
|
||||
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
|
||||
we're waiting on the server to start.
|
||||
|
||||
|
@ -10,7 +10,7 @@ gets a new protocol version.
|
||||
|
||||
## 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):
|
||||
|
||||
@ -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
|
||||
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.
|
||||
|
@ -14,8 +14,8 @@ Open a terminal, go to the server directory, and make sure you can execute it:
|
||||
.\lazymc --help
|
||||
```
|
||||
|
||||
When `lazymc` is ready, set up the [configuration](./res/lazymc.toml) and start
|
||||
it up:
|
||||
When lazymc is ready, set up the [configuration](./res/lazymc.toml) and start it
|
||||
up:
|
||||
|
||||
```bash
|
||||
# In your Minecraft server directory:
|
||||
|
@ -1,5 +1,7 @@
|
||||
#!/bin/bash
|
||||
|
||||
# See: https://git.io/JMIKH
|
||||
|
||||
# Server JAR file, set this to your own
|
||||
FILE=server.jar
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user