Skip to content

Clarify source build docs for qt6 branch and cmake compat #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trasnake87 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Clarify source build docs for qt6 branch and cmake compat #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d823c9a
Clarify source build instructions for qt6 branch and cmake compatibility
trasnake87 Feb 6, 2026
9cac483
Fix branch name references and remove incorrect cmake 4.0 claims
trasnake87 Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions src/source_build/launcher.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

<div class="warning">

The qt5 version is deprecated and only supported on distributions with protobuf that not depends on abseil and uses cmake 3.x.
The default (ng) branch uses Qt5 and is deprecated. It is only supported on distributions with protobuf that does not depend on abseil and that use cmake 3.x.

Use branch qt6 for cmake 4.0 and newer protobuf.
**For most users, the `qt6` branch is recommended.** It supports newer protobuf. See the [qt6 branch instructions](#building-the-qt6-branch-recommended) below.

</div>

Expand All @@ -16,18 +16,31 @@ Use branch qt6 for cmake 4.0 and newer protobuf.
- **Fedora** (Up to date as of 2024-08-21) - you'll need to install the
required packages:
`sudo dnf install clang cmake make git ca-certificates libstdc++ glibc-devel libpng-devel zlib-devel libX11-devel libXi-devel libcurl-devel systemd-devel libevdev-devel mesa-libEGL-devel alsa-lib-devel pulseaudio-libs-devel mesa-dri-drivers systemd-devel libXtst-devel openssl-devel qt5-qtbase-devel qt5-qtwebengine-devel qt5-qtdeclarative-devel qt5-qtsvg-devel qt5-qtquickcontrols qt5-qtquickcontrols2`
- **Arch** (Up to date as of 2024-12-02) - you'll need to install the
- **Arch** (Up to date as of 2024-12-02) - you'll need to install the
required packages:
`sudo pacman -S gcc clang ca-certificates openssl libpng libx11 libxi gcc-libs glibc zlib curl systemd libevdev mesa alsa-lib pulseaudio libxtst qt5-base qt5-webengine qt5-declarative qt5-svg qt5-quickcontrols qt5-quickcontrols2`
- **macOS** - you'll need to install the required packages:
`brew install cmake libpng openssl@1.1 qt@5`

## Build instructions
## Building the qt6 branch (recommended)

The `qt6` branch is the actively maintained branch. To build it:

``` bash
git clone --recursive -b qt6 https://github.com/minecraft-linux/mcpelauncher-manifest.git mcpelauncher && cd mcpelauncher
mkdir -p build && cd build
CC=clang CXX=clang++ cmake .. -Wno-dev -DCMAKE_BUILD_TYPE=Release -DJNI_USE_JNIVM=ON
make -j$(getconf _NPROCESSORS_ONLN)
```

## Build instructions (ng branch, deprecated)

> **Warning:** The ng branch uses Qt5 and is deprecated. Prefer the [qt6 branch](#building-the-qt6-branch-recommended) unless you specifically need the Qt5 version.

``` bash
git clone --recursive https://github.com/minecraft-linux/mcpelauncher-manifest.git mcpelauncher && cd mcpelauncher
mkdir -p build && cd build
CC=clang CXX=clang++ cmake .. -Wno-dev -DCMAKE_BUILD_TYPE=Release -DJNI_USE_JNIVM=ON
CC=clang CXX=clang++ cmake .. -Wno-dev -DCMAKE_BUILD_TYPE=Release -DJNI_USE_JNIVM=ON
make -j$(getconf _NPROCESSORS_ONLN)
```

Expand Down