mirror of
https://github.com/timvisee/lazymc.git
synced 2025-05-19 04:40:22 -07:00
Update README, improve usage/compile instructions, add Windows guide
This commit is contained in:
parent
7c7595dcd3
commit
f9be5c5a0f
66
README.md
66
README.md
@ -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
|
incoming status connections until the server is started and then transparently
|
||||||
relays/proxies the rest. All without them noticing.
|
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
|
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
|
## Usage
|
||||||
|
|
||||||
|
_Note: these instructions are for Linux & macOS, for Windows look
|
||||||
|
[here](./docs/usage-windows.md)._
|
||||||
|
|
||||||
Make sure you meet all [requirements](#requirements).
|
Make sure you meet all [requirements](#requirements).
|
||||||
|
|
||||||
_Note: Installation options are limited at this moment. Ready-to-go binaries
|
Download the appropriate binary for your system from the [latest
|
||||||
will be published later. For now we compile and install from source._
|
release][latest-release] page.
|
||||||
|
|
||||||
To compile and install you need Rust, install it through `rustup`: https://rustup.rs/
|
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:
|
||||||
When Rust is installed, compile and install `lazymc` from this git repository:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Compile and install lazymc from source
|
chmod a+x ./lazymc
|
||||||
cargo install -f --git https://github.com/timvisee/lazymc
|
./lazymc --help
|
||||||
|
|
||||||
# Ensure lazymc works
|
|
||||||
lazymc --help
|
|
||||||
```
|
```
|
||||||
|
|
||||||
When `lazymc` is available, change into your server directory. Then set up the
|
When `lazymc` is set-up, change into your server directory if you haven't
|
||||||
[configuration](./res/lazymc.toml) and start it up:
|
already. Then set up the [configuration](./res/lazymc.toml) and start it up:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Change into your server directory
|
# Change into your server directory (if you haven't already)
|
||||||
cd server
|
cd server
|
||||||
|
|
||||||
# Generate lazymc configuration
|
# Generate lazymc configuration
|
||||||
@ -95,6 +92,45 @@ lazymc start
|
|||||||
Everything should now be running. Connect with your Minecraft client to wake
|
Everything should now be running. Connect with your Minecraft client to wake
|
||||||
your server up!
|
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
|
## License
|
||||||
|
|
||||||
This project is released under the GNU GPL-3.0 license.
|
This project is released under the GNU GPL-3.0 license.
|
||||||
|
37
docs/usage-windows.md
Normal file
37
docs/usage-windows.md
Normal 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
|
Loading…
x
Reference in New Issue
Block a user