Update README, improve usage/compile instructions, add Windows guide

This commit is contained in:
timvisee 2021-11-11 15:05:05 +01:00
parent 7c7595dcd3
commit f9be5c5a0f
No known key found for this signature in database
GPG Key ID: B8DB720BC383E172
2 changed files with 88 additions and 15 deletions

View File

@ -18,8 +18,6 @@ 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.
_Note: this is a prototype and may be incomplete._
https://user-images.githubusercontent.com/856222/141307395-c6252332-7fdb-4443-b9ae-1021a03f9650.mp4
@ -57,28 +55,27 @@ won't be able to set this up._
## Usage
_Note: these instructions are for Linux & macOS, for Windows look
[here](./docs/usage-windows.md)._
Make sure you meet all [requirements](#requirements).
_Note: Installation options are limited at this moment. Ready-to-go binaries
will be published later. For now we compile and install from source._
Download the appropriate binary for your system from the [latest
release][latest-release] page.
To compile and install you need Rust, install it through `rustup`: https://rustup.rs/
When Rust is installed, compile and install `lazymc` from this git repository:
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:
```bash
# Compile and install lazymc from source
cargo install -f --git https://github.com/timvisee/lazymc
# Ensure lazymc works
lazymc --help
chmod a+x ./lazymc
./lazymc --help
```
When `lazymc` is available, change into your server directory. 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
# Change into your server directory (if you haven't already)
cd server
# Generate lazymc configuration
@ -95,6 +92,45 @@ lazymc start
Everything should now be running. 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
later._
[latest-release]: https://github.com/timvisee/lazymc/releases/latest
## Compile from source
Make sure you meet all [requirements](#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:
```bash
# 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:
```bash
# Clone repository
git clone https://github.com/timvisee/lazymc
cd lazymc
# Compile
cargo build --release
# Run lazymc
./target/release/lazymc --help
```
## License
This project is released under the GNU GPL-3.0 license.

37
docs/usage-windows.md Normal file
View File

@ -0,0 +1,37 @@
## Usage on Windows
Make sure you meet all [requirements](../README.md#requirements).
Download the `lazymc-*-windows.exe` Windows executable for your system from the
[latest release][latest-release] page.
Place the binary in your Minecraft server directory, and rename it to
`lazymc.exe`.
Open a terminal, go to the server directory, and make sure you can execute it:
```bash
lazymc --help
```
When `lazymc` is ready, set up the [configuration](./res/lazymc.toml) and start
it up:
```bash
# In your Minecraft server directory:
# Generate lazymc configuration
lazymc config generate
# Edit configuration
# Set the correct server address, directory and start command
notepad lazymc.toml
# Start lazymc
lazymc start
```
Everything should now be running. Connect with your Minecraft client to wake
your server up!
[latest-release]: https://github.com/timvisee/lazymc/releases/latest