Miniera

Run Minecraft servers

Features

• Host both Java and Bedrock servers
• Host modded Java servers
• Host servers for others to join (powered by ngrok)

Chat

Contributing

See CONTRIBUTING.md for details on how can you help the project and how to provide information so we can help you in case of troubles with the app.

Building Manually

Miniera uses vcpkg to manage its dependencies and cmake as its build system.

Ensure both vcpkg and cmake are installed on your system before building.

A C++20 compiler is also required to build Miniera.

If building the GNOME version, blueprint-compiler must be installed from your system package manager as it is not available on vcpkg.

Configuring vcpkg

1. Set the VCPKG_ROOT environment variable to the path of your vcpkg installation's root directory.

Windows

1. Set the VCPKG_DEFAULT_TRIPLET environment variable to x64-windows
2. Run vcpkg install libnick qtbase qtsvg qttools qlementine qlementine-icons

Linux (GNOME)

1. Set the VCPKG_DEFAULT_TRIPLET environment variable to x64-linux
2. Run vcpkg install libnick libxmlpp

Linux (Qt)

1. Set the VCPKG_DEFAULT_TRIPLET environment variable to x64-linux
2. Run vcpkg install libnick qtbase qtsvg qttools qlementine qlementine-icons

Building

1. First, clone/download the repo.
2. Open a terminal and navigate to the repo's root directory.
3. Create a new build directory and cd into it.

Windows

1. From the build folder, run cmake .. -G "Visual Studio 17 2022".
2. From the build folder, run cmake --build . --config Release.
3. After these commands complete, Miniera will be successfully built and its binaries can be found in the org.nickvision.minieria.qt/Release folder of the build folder.

Linux (GNOME)

1. From the build folder, run cmake .. -DCMAKE_BUILD_TYPE=Release -DUI_PLATFORM=gnome.
2. From the build folder, run cmake --build ..
3. After these commands complete, Miniera will be successfully built and its binaries can be found in the org.nickvision.minieria.gnome folder of the build folder.

Linux (Qt)

1. From the build folder, run cmake .. -DCMAKE_BUILD_TYPE=Release -DUI_PLATFORM=qt.
2. From the build folder, run cmake --build ..
3. After these commands complete, Miniera will be successfully built and its binaries can be found in the org.nickvision.minieria.qt folder of the build folder.

Code of Conduct

This project follows the GNOME Code of Conduct.