Prism Launcher

https://prismlauncher.org/wiki
Admin
Prism Launcher is a free and open source Minecraft launcher that manages multiple accounts and...
Tokens:20,520
Snippets:266
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Flatpak: Run the build

Source: https://prismlauncher.org/wiki/development/build-instructions

Run the Flatpak build using org.flatpak.Builder. The --install flag installs the build; comment it out to only build. Requires Flathub setup.

```bash
# Enter the Flatpak directory
cd PrismLauncher/flatpak


# Run the build
flatpak run org.flatpak.Builder \
  --user \
  --install \ # Comment if you only want to build, not install
  --install-deps-from=flathub \
  --ccache \
  --repo=repo \
  builddir \
  org.prismlauncher.PrismLauncher.yml

```

--------------------------------

### Install Qt via aqt

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs aqtinstall and then uses it to install Qt 6 for Windows with the required addons (qtimageformats, qtnetworkauth).

```bash
winget install --source winget --exact --id miurahr.aqtinstall
aqt install-qt windows desktop 6 win64_msvc2022_64 -m qtimageformats qtnetworkauth
```

--------------------------------

### Install with CMake preset linux

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs the build. Optionally installs the portable component or uses DESTDIR for packaging.

```bash
cmake --install build --config Debug
cmake --install build --config Debug --component portable # If you want to install a portable version
DESTDIR="$pkgdir" cmake --install build --config Debug # If you're installing for a package
```

--------------------------------

### Install Git via winget

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs Git using winget. Needed for cloning the repository.

```bash
winget install --source winget --exact --id Git.Git
```

--------------------------------

### Install with CMake preset windows_msvc

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs the build. Optionally installs the portable component.

```bash
cmake --install build --config Debug
cmake --install build --config Debug --component portable # If you want to install a portable version
```

--------------------------------

### Install MSYS2 dependencies with pacboy

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs all required dependencies for building PrismLauncher in the MSYS2 CLANG(ARM)64 environment. Requires the CLANG(ARM)64 environment to be started first.

```bash
pacman -Syu pactoys git
pacboy -S \
  toolchain:p \
  cmake:p ninja:p \
  extra-cmake-modules:p \
  qt6-base:p qt6-imageformats:p qt6-networkauth:p qt6-svg:p \
  cmark:p \
  libarchive:p \
  qrencode:p \
  tomlplusplus:p \
  zlib:p
```

--------------------------------

### Flatpak: Install build tools and clone repository

Source: https://prismlauncher.org/wiki/development/build-instructions

Install Flatpak build tools and clone the Prism Launcher source repository recursively.

```bash
# Install Flatpak build tools
flatpak install flathub org.flatpak.Builder


# Clone the source repository
git clone --recursive https://github.com/prismlauncher/PrismLauncher

```

--------------------------------

### Install JDK 17 on Ubuntu

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs OpenJDK 17 on Ubuntu or derivatives using apt.

```bash
sudo apt install openjdk-17-jdk
```

--------------------------------

### Install Java on Ubuntu, Pop!_OS, Linux Mint, Zorin OS, or elementaryOS

Source: https://prismlauncher.org/wiki/getting-started/installing-java

Installs the required Java runtimes using apt.

```bash
sudo apt install openjdk-17-jre openjdk-8-jre openjdk-21-jre

```

--------------------------------

### Install Java on Debian or MX Linux

Source: https://prismlauncher.org/wiki/getting-started/installing-java

Installs the required Java runtimes using apt.

```bash
sudo apt install openjdk-17-jre openjdk-21-jre

```

--------------------------------

### Install with CMake preset macos

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs the build.

```bash
cmake --install build --config Debug
```

--------------------------------

### Install macOS dependencies with Homebrew

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs Qt, cmake, ninja, and other dependencies via Homebrew, then clones vcpkg and sets VCPKG_ROOT.

```bash
brew install cmake pkg-config ninja extra-cmake-modules openjdk@17 vcpkg qt
git clone https://github.com/Microsoft/vcpkg ~/vcpkg
export VCPKG_ROOT="$HOME/vcpkg"
```

--------------------------------

### Install JDK 17 on Debian

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs JDK 17 (Temurin) on Debian by adding the Adoptium repository and installing temurin-17-jdk.

```bash
sudo apt install wget apt-transport-https gpg
wget -qO - https://packages.adoptium.net/artifactory/api/gpg/key/public | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/adoptium.gpg > /dev/null
echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
sudo apt update && sudo apt install temurin-17-jdk
```

--------------------------------

### Install Debian/Ubuntu dependencies with apt

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs all required build dependencies for Debian-based systems using apt.

```bash
sudo apt install \
  build-essential \
  cmake ninja-build extra-cmake-modules pkg-config scdoc \
  qt6-base-dev qt6-image-formats-plugins qt6-networkauth-dev qt6-svg-dev \
  cmark gamemode-dev libarchive-dev libcmark-dev libgl1-mesa-dev libqrencode-dev libtomlplusplus-dev libvulkan-dev zlib1g-dev
```

--------------------------------

### VS Code c_cpp_properties.json example for macOS with Qt via Homebrew

Source: https://prismlauncher.org/wiki/development/ides-and-tooling

Example configuration for VS Code's C/C++ extension on macOS with Qt installed via Homebrew. Sets includePath, compilerArgs, compileCommands, and cppStandard to c++17. Requires CMake to generate compile_commands.json by adding -DCMAKE_EXPORT_COMPILE_COMMANDS=ON.

```json
{
  "configurations": [
    {
      "name": "Mac (PrismLauncher)",
      "includePath": [
        "${workspaceFolder}/**",
        "/opt/homebrew/opt/qt@6/include/**"
      ],
      "defines": [],
      "macFrameworkPath": [
        "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks"
      ],
      "compilerPath": "/usr/bin/clang",
      "compilerArgs": ["-L/opt/homebrew/opt/qt@6/lib"],
      "compileCommands": "${workspaceFolder}/build/compile_commands.json",
      "cStandard": "c17",
      "cppStandard": "c++17",
      "intelliSenseMode": "macos-clang-arm64"
    }
  ],
  "version": 4
}
```

--------------------------------

### Install JDK 17 via winget

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs JDK 17 (Temurin) using winget. Required for building PrismLauncher.

```bash
winget install --source winget --exact --id EclipseAdoptium.Temurin.17.JDK
```

--------------------------------

### Install Xcode Command Line Tools

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs the Xcode command line tools, required for building on macOS.

```bash
xcode-select --install
```

--------------------------------

### Install Java on Void Linux with xbps

Source: https://prismlauncher.org/wiki/getting-started/installing-java

Installs the required Java runtimes (8, 17, and 21) on Void Linux using the xbps package manager.

```bash
sudo xbps-install openjdk17-jre openjdk8-jre openjdk21-jre

```

--------------------------------

### Install Arch Linux dependencies with pacman

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs all required build dependencies for Arch Linux using pacman.

```bash
sudo pacman -S \
  base-devel \
  cmake ninja extra-cmake-modules pkg-config scdoc \
  qt6-base qt6-imageformats qt6-networkauth qt6-svg \
  cmark gamemode libarchive mesa qrencode tomlplusplus zlib \
  jdk17-openjdk
```

--------------------------------

### Install Java on Fedora, RHEL, CentOS, AlmaLinux, or RockyLinux

Source: https://prismlauncher.org/wiki/getting-started/installing-java

Use the dnf package manager to install the required Java versions (1.8.0, 17, and 21). The COPR package should already include all required Java versions, but this command installs them explicitly.

```bash
sudo dnf install java-1.8.0-openjdk java-17-openjdk java-21-openjdk

```

--------------------------------

### Install MSYS2 via winget

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs MSYS2 using winget. Alternative to the MSVC toolchain for Windows builds.

```bash
winget install --exact --id MSYS2.MSYS2 --source winget
```

--------------------------------

### Nix: Enter development shell and build manually

Source: https://prismlauncher.org/wiki/development/build-instructions

Enter a development shell with all required tools, then configure, build, and install using CMake presets.

```bash
nix-shell
cmake --preset linux_debug
cmake --build build
cmake --install build

```

--------------------------------

### Install Java on Arch Linux, Manjaro, EndeavorOS, or Garuda

Source: https://prismlauncher.org/wiki/getting-started/installing-java

Installs the required Java runtimes (8, 17, and 21) using pacman.

```bash
sudo pacman -S jre17-openjdk jre8-openjdk jre21-openjdk

```

--------------------------------

### catpack.json configuration example

Source: https://prismlauncher.org/wiki/getting-started/catpacks

Example catpack.json defining the CatPack name, default cat, and time-based variants. Variants are matched by checking if today's date falls between startTime and endTime (inclusive); the first matching variant in the list is used, so order matters.

```json
{
  "name": "My Cute Cat",
  "default": "maxwell.png",
  "variants": [
    {
      "startTime": {
        "day": 12,
        "month": 4
      },
      "endTime": {
        "day": 12,
        "month": 4
      },
      "path": "oneDay.png"
    },
    {
      "startTime": {
        "day": 20,
        "month": 12
      },
      "endTime": {
        "day": 28,
        "month": 12
      },
      "path": "christmas.png"
    },
    {
      "startTime": {
        "day": 30,
        "month": 12
      },
      "endTime": {
        "day": 1,
        "month": 1
      },
      "path": "newyear2.png"
    },
    {
      "startTime": {
        "day": 28,
        "month": 12
      },
      "endTime": {
        "day": 3,
        "month": 1
      },
      "path": "newyear.png"
    }
  ]
}
```

--------------------------------

### Nix: Build debug package

Source: https://prismlauncher.org/wiki/development/build-instructions

Run this command after installing Nix and checking out the repository to build a debug package.

```bash
nix build --print-build-logs '.#prismlauncher-debug'

```

--------------------------------

### Install MSVC Build Tools via winget

Source: https://prismlauncher.org/wiki/development/build-instructions

Installs the MSVC 2022 Build Tools with the VCTools workload using winget. Required for compiling on Windows.

```bash
winget install --source winget --exact --id Microsoft.VisualStudio.2022.BuildTools --override '--add Microsoft.VisualStudio.Workload.VCTools;includeRecommended'
```

--------------------------------

### Install Java 8, 17, and 21 on Windows 11 with winget

Source: https://prismlauncher.org/wiki/getting-started/installing-java

On Windows 11, this command automatically installs Java 21, 17, and 8 using the Windows Package Manager. Run it in the Terminal app.

```powershell
winget install Microsoft.OpenJDK.21; winget install Microsoft.OpenJDK.17; winget install EclipseAdoptium.Temurin.8.JDK
```

--------------------------------

### Switch to classic zlib with pacman

Source: https://prismlauncher.org/wiki/overview/troubleshooting

Switches to classic zlib on CachyOS to resolve MinecraftForge installer hash-check failures caused by zlib-ng incompatibility.

```shell
sudo pacman -S zlib lib32-zlib

```

--------------------------------

### Prism Launcher command-line usage and options

Source: https://prismlauncher.org/wiki/getting-started/command-line-interface

Shows the full command-line usage and all available options for prismlauncher. The --server and --profile options are only valid in combination with --launch.

```text
Usage: prismlauncher [-h] [-v] [-d dir] [-l launch] [-s server] [-a profile] [-I import] [--show show] [--alive] [--help-all]


Options:
  -d, --dir directory    Use a custom path as application root (use '.' for current directory)
  -l, --launch instance  Launch the specified instance (by instance ID)
  -s, --server address   Join the specified server on launch (only valid in combination with --launch)
  -a, --profile profile  Use the account specified by its profile name (only valid in combination with --launch)
  --alive                Write a small 'live.check' file after the launcher starts
  -I, --import file      Import instance from specified zip (local path or URL)
  --show show            Opens the window for the specified instance (by instance ID)
  -h, --help             Displays help on commandline options.
  --help-all             Displays help, including generic Qt options.
  -v, --version          Displays version information.

```

--------------------------------

### Configure with CMake preset macos

Source: https://prismlauncher.org/wiki/development/build-instructions

Configures the build for macOS, setting the Qt prefix path and the deployment target to 12.

```bash
cmake --preset macos \
  -D CMAKE_PREFIX_PATH="/opt/homebrew/opt/qt" \
  -D CMAKE_OSX_DEPLOYMENT_TARGET=12
```

--------------------------------

### Configure with CMake preset windows_msvc

Source: https://prismlauncher.org/wiki/development/build-instructions

Run in 'x64 Native Tools PowerShell' on Windows. Sets the Qt prefix path to the given location.

```powershell
cmake --preset windows_msvc -D CMAKE_PREFIX_PATH="C:\path\to\Qt"
```

--------------------------------

### Crash log: critical tampering error

Source: https://prismlauncher.org/wiki/overview/troubleshooting

Example crash log from a very old Forge modpack with a modern Java 8 runtime, showing a critical tampering error.

```text
2024-02-28 10:31:56 [SEVERE] [ForgeModLoader] The minecraft jar file:/home/********/.var/app/org.prismlauncher.PrismLauncher/data/PrismLauncher/libraries/com/mojang/minecraft/1.6.4/minecraft-1.6.4-client.jar!/net/minecraft/client/ClientBrandRetriever.class appears to be corrupt! There has been CRITICAL TAMPERING WITH MINECRAFT, it is highly unlikely minecraft will work! STOP NOW, get a clean copy and try again!
```

--------------------------------

### Crash log: mod validation failure

Source: https://prismlauncher.org/wiki/overview/troubleshooting

Example crash log from a very old Forge modpack with a modern Java 8 runtime, showing a mod validation failure.

```text
2024-02-28 10:35:15 [SEVERE] [Forestry] myrathi.flatsigns.FlatSigns failed validation. Halting runtime for security reasons. Please replace your mods with untampered versions from the official download sites.
```

--------------------------------

### Clone PrismLauncher repository

Source: https://prismlauncher.org/wiki/development/build-instructions

Clones the PrismLauncher repository with all submodules. The rest of the documentation assumes this has been done.

```bash
git clone --recursive https://github.com/PrismLauncher/PrismLauncher.git
cd PrismLauncher
```

--------------------------------

### Crash log: mod validation failure (IC2)

Source: https://prismlauncher.org/wiki/overview/troubleshooting

Another example crash log from a very old Forge modpack with a modern Java 8 runtime, showing a mod validation failure.

```text
2023-01-23 16:10:09 [SEVERE] [Forestry] ic2.core.IC2 failed validation. Halting runtime for security reasons. Please replace your mods with untampered versions from the official download sites.
```

--------------------------------

### Make Prism Launcher AppImage executable with chmod

Source: https://prismlauncher.org/wiki/overview/troubleshooting

Grants execute permission to the Prism Launcher AppImage. Navigate to the AppImage's location first and adjust the version number in the filename if needed.

```bash
chmod +x PrismLauncher-Linux-{{version.current}}-x86_64.AppImage
```

--------------------------------

### Configure with CMake preset linux

Source: https://prismlauncher.org/wiki/development/build-instructions

Configures the build using the linux preset.

```bash
cmake --preset linux
```
Tokens:
Raw