https://github.com/nickvisionapps/miniera
Run Minecraft servers
https://github.com/nickvisionapps/miniera
Last synced: 4 months ago
JSON representation
Run Minecraft servers
- Host: GitHub
- URL: https://github.com/nickvisionapps/miniera
- Owner: NickvisionApps
- License: gpl-3.0
- Created: 2025-02-22T03:44:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-21T22:13:56.000Z (about 1 year ago)
- Last Synced: 2025-04-21T23:24:57.491Z (about 1 year ago)
- Language: C++
- Size: 396 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: COPYING
Awesome Lists containing this project
README
# 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](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`
1. Run `vcpkg install libnick qtbase qtcharts qtsvg qttools qlementine qlementine-icons`
#### Linux (GNOME)
1. Set the `VCPKG_DEFAULT_TRIPLET` environment variable to `x64-linux`
1. Run `vcpkg install libnick libxmlpp`
#### Linux (Qt)
1. Set the `VCPKG_DEFAULT_TRIPLET` environment variable to `x64-linux`
1. Run `vcpkg install libnick qtbase qtcharts qtsvg qttools qlementine qlementine-icons`
### Building
1. First, clone/download the repo.
1. Open a terminal and navigate to the repo's root directory.
1. Create a new `build` directory and `cd` into it.
#### Windows
1. From the `build` folder, run `cmake .. -G "Visual Studio 17 2022"`.
1. From the `build` folder, run `cmake --build . --config Release`.
1. 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`.
1. From the `build` folder, run `cmake --build .`.
1. 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`.
1. From the `build` folder, run `cmake --build .`.
1. 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](https://conduct.gnome.org/).