Gooxey / mcmanage

This application is aiming to make the creation and management of Minecraft servers as easy as possible.

MCManage

This application is aiming to make the creation and management of Minecraft servers as easy as possible.

Disclaimer

This project is still in very early development.

Features

Minecraft server

• Starts Minecraft servers configured in the config/server_list.toml file. ( The Minecraft server must be stored under servers/<the name of the server> )
• Restarts a Minecraft server regularly if configured in the config/server_list.toml file.
• Stores the logs of each server under logs/servers/<the name of the server>.log
• Automatically agrees to the EULA if configured in the config/config.toml file.
• Downloads the server jar if needed from a link specified in the config/server_list.toml file.
• Shuts down the computer running this application after some time of no player activity on any Minecraft server, if configured in the config/server_list.toml file.

UI

• Hosts an UI to the port specified in the config/config.toml file. (The UI's files can be found at share/frontend)
• Using the REST API of this application, one can replace the official UI with a custom one.

Configuration

In the future, you can use this application fully via a website hosted by this application, but for now, the use of files for configuration is unavoidable.#

There are many files generated by this application, but the only ones YOU should edit are the ones stored inside the config/ folder. Each name pretty much sums up what it is for, and if you make a mistake, it will be either corrected or an example file will be created.

The servers folder can also be modified since it is the one storing all Minecraft servers.

Requirements

First, you have to install rust. See https://www.rust-lang.org/tools/install for more details on how to install it.

Next, you need to install trunk.

# Note that this is just one of multiple ways to install trunk.
# For a full list, see https://trunkrs.dev/#install
cargo install --locked trunk

After that, there is just one command missing:

rustup target add wasm32-unknown-unknown

Note that you might have to install Java to start the Minecraft servers.

Install

To build the application, go into the root folder and run this command:

cargo build --release

After that, you will be able to get the executable from ./target/release/mcmanage.exe

History

To see the full history of the MCManage project see the mcm_archive.

License

GNU General Public License v3.0