statik-rs

statik is (hopefully will become) a lightweight, containerisable minecraft server with the sole purpose of making a server appear online while it is not, sending a signal to start the actual server. This allows the typically high mem and cpu intensive java minecraft server be closed when no-one is playing, yet still have clients see the server as being online.

Statik's MSRV (Minimum Supported Rust Version) is whatever the most recent version of Rust is, as this project may contain recent rust features that don't exist in previous versions.

Usage

To run statik, you must have rust installed via rustup.

To run the server on default port 25565, run this command:

$ cargo run --release

While in development just run:

$ cargo run

(This will compile the projects dependencies with release mode, but have the actual binary compiled with the default dev profile and debug assertions)

various settings can be configured through the statik.toml file - this can be provided in whatever directory the run command was executed in, or will be automatically generated if it doesn't yet exist.

Or change the default statik.toml config file:

$ cargo run -- --config=my_config_file.toml

And when everything is finalised, run the server in release mode:

$ cargo run --release

Credits

This project takes heavy inspiration and couldn't be created without the hard work put into the following projects:

• limbo - the main inspiration for statik, designed for a very similar use case but left undeveloped since May 2022
• bamboo - an attempt at re-writing the minecraft server java code from scratch in rust
• feather - another minecraft server re-write that hasn't had a commit since June 2022
• tokio's mini-redis tutorial - a well implimented example tokio server that accepts and processes TCP connections, helping me layout and build this server.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.