ProjT Launcher - Project Tick
=============================

NOTE: Infrastructure transition in progress

ProjT Launcher is currently migrating its primary development
infrastructure from GitHub to a self-hosted stack based on
gitolite and cgit.

GitHub repositories are used as mirrors and for transitional
CI workflows only. The authoritative source of truth is:

https://git.projecttick.org.tr/projt-launcher.git

A Minecraft launcher and automation stack that helps maintainers avoid missed
updates, security drift, and broken metadata in long-lived projects.

A fork of Prism Launcher, diverging on purpose to keep maintenance and infrastructure
healthy over time. Built for projects that rely on CI, automation, and long-term maintenance,
often maintained by small teams or individuals.

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

Projects
--------

This repo is a monorepo with the launcher and the pieces that keep it running:

- Launcher app (C++/Qt): launcher/, CMakeLists.txt
- Website (Eleventy): website/, public/, package.json
- Automation bot (Cloudflare Workers): bot/
- Metadata generator (Python/Poetry): meta/, pyproject.toml
- Docs/CI/Tools: docs/, ci/, .github/workflows/, scripts/, tools/
- Forked libraries: bzip2/, quazip/, zlib/, libnbtplusplus/
- Bundled libraries: gamemode/, LocalPeer/, murmur2/, qdcss/, rainbow/, systeminfo/
- Non-Fork libraries: launcherjava/

WARNING:
Forks are expected; large rebundling or CI changes should clearly document intent.

Reading Guide
-------------

This README is intentionally a repository handbook.
It centralizes project philosophy, infrastructure, and
long-term maintenance documentation in one place.

This README serves multiple audiences and use cases.

Users
-----

If you are looking to install or use ProjT Launcher, focus on:
  
- Launcher Releases
- Quick Starts
- Community & Support

Contributors
------------

If you plan to contribute code or documentation, read:

- What is ProjT Launcher?
- Project Philosophy
- Design Goals
- Documentation
- Contributing

Packagers / Maintainers / Reviewers
-----------------------------------

If you are reviewing this repository for distribution, licensing, or long-term maintenance, the following sections are relevant:

- Forked Libraries (Detailed)
- CI & Automation
- License for ProjT Launcher

Sections documenting forked upstream projects are intentionally
detailed and may be skipped by readers only interested in usage.

What is ProjT Launcher?
-----------------------

ProjT Launcher is a fork of Prism Launcher with a deliberate focus on long-term maintainability, structural clarity, and respect for upstream ecosystems. We care more about boring reliability than shipping features fast. Clean architecture, reproducible builds, disciplined CI, and packaging correctness across Linux, Windows, macOS, Nix, and Flatpak come first.

We keep the core experience familiar and diverge only when the original architecture or maintenance model makes long-term upkeep harder. That divergence is a practical choice, not a statement about upstream quality.

Project Philosophy
~~~~~~~~~~~~~~~~~~

- Stability, clarity, and auditability come before new features.
- Changes should be traceable and maintainable years later.
- Infrastructure, tooling, CI, and refactors are first-class work.
- Packaging correctness and reproducible builds are non-negotiable.
- We prioritize long-term maintainability over short-term feature velocity.

Design Goals
~~~~~~~~~~~~

- Maintain a modular architecture with clear boundaries and minimal hidden coupling.
- Keep CI deterministic, with consistent tooling across platforms and ecosystems.
- Prefer documented, repeatable solutions over clever but fragile shortcuts.
- Keep build and packaging workflows aligned with downstream expectations and policies.

Who This Project Is For
~~~~~~~~~~~~~~~~~~~~~~~

- Developers who value maintainable codebases and long-lived infrastructure.
- Packagers and distro maintainers who need reproducible builds and clear conventions.
- Contributors who are comfortable with quiet, incremental work: refactors, CI, build tooling.
- Users who prefer stability and predictable behavior over rapid feature churn.

Who This Project Is Not For
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Anyone prioritizing rapid feature churn over maintainability and clarity.
- Those expecting this fork to track upstream decisions, timelines, or design shortcuts.
- If you want the fastest new features, upstream may be a better fit.

Launcher Releases
-----------------

ProjT Launcher is available in various package repositories. Check the badge above for current distributions and versions.

NOTE:
Distribution availability varies and is maintained independently by downstream packagers.

Stable Options
~~~~~~~~~~~~~~

- Official Releases: Download installers/binaries from https://projtlauncher.projecttick.org.tr/download/
- Package Manager: Install your distro's projtlauncher package.
- Build from Source: Follow the launcher build steps below for a reproducible release build.

Development Builds (Unstable)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

These are for testing and contributors only:

- CI Artifacts: Check GitHub Actions for builds.
- Nix Flake: nix build .#projtlauncher
- Local Build: cmake -S . -B build && cmake --build build

Quick Starts
------------

Launcher (C++/Qt)
~~~~~~~~~~~~~~~~~

Prerequisites
^^^^^^^^^^^^^

- CMake 3.22+
- Qt 6.x
- C++20 compiler
- Git submodules

Quick Build
^^^^^^^^^^^

Commands:

git clone --recursive https://github.com/YongDo-Hyun/ProjT-Launcher.git
cd ProjT-Launcher
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release

Website (Eleventy)
~~~~~~~~~~~~~~~~~~

Commands:

pnpm install
pnpm serve

The website source lives in website/, and the production output is built into public/

Bot (Cloudflare Workers)
~~~~~~~~~~~~~~~~~~~~~~~~

Local smoke test commands:

cd bot
wrangler dev

Metadata Generator (Python/Poetry)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ProjT Launcher Meta by Yong Do-Hyun. Scripts to generate JSONs and jars that ProjT Launcher will access. The metadata generator lives in meta/ and is wired via pyproject.toml

Recommended Deployment (CI)
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The old Flake-based NixOS deployment is removed. Use the GitHub Actions workflow in .github/workflows/auto-update.yml (hourly schedule + manual dispatch).

Secrets supported by the workflow:

- DEPLOY_PAT (preferred, must have access to meta-upstream and meta-launcher)
- META_BOT_TOKEN (fallback if no PAT)
- DEPLOY_SSH_KEY_UPSTREAM and DEPLOY_SSH_KEY_LAUNCHER (SSH alternative)
- META_UPSTREAM_URL and META_LAUNCHER_URL (optional custom repo URLs)

Local Run
^^^^^^^^^

Set META_UPSTREAM_URL and META_LAUNCHER_URL (or define them in config.sh), then:

Commands:

python -m pip install -r requirements.txt
python -m pip install .
./init.sh
./update.sh

Documentation
-------------

Launcher contributor docs:

- docs/contributing/GETTING_STARTED: Setup your environment (Windows/Linux/macOS).
- docs/contributing/CODE_STYLE: Strict rules for C++ and Qt Widgets.
- docs/contributing/PROJECT_STRUCTURE: Where to put your files.
- docs/contributing/ARCHITECTURE: Understanding MVVM and the Task system.
- docs/architecture/OVERVIEW: A guided tour of modules, data flow, and contracts.
- docs/contributing/WORKFLOW: How to submit a Pull Request.
- docs/contributing/TESTING: How to write and run tests.

Contributing
------------

Start with CONTRIBUTING for engineering standards and workflow. Project-specific notes:

- Launcher: docs/contributing/
- Website: .eleventy.js, website/, package.json
- Bot: bot/README.md
- Metadata generator: meta/, pyproject.toml

macOS Notes
-----------

- Apple Silicon is prioritized.
- Universal binaries work on Intel macOS but are deprecated.
- See docs/APPLE_SILICON_RATIONALE for details.

Community & Support
-------------------

- Mailing Lists: Report bugs or suggest features on Mailing Lists.
- Translations: Use upstream Prism strings for now; own workflow coming.
- Community Spaces: Community channels may be announced in the future.

Forking & Redistribution
------------------------

You can fork and redistribute freely under the GPL-3.0 license. For custom builds:

- Clearly state it's not official ProjT Launcher.
- Change API keys in CMakeLists.txt to your own or disable them.
- Set Launcher_BUILD_PLATFORM for distributions (e.g., archlinux).

Building with default API keys implies acceptance of:

- https://docs.microsoft.com/en-us/legal/microsoft-identity-platform/terms-of-use
- https://support.curseforge.com/en/support/solutions/articles/9000207405-curse-forge-3rd-party-api-terms-and-conditions

Infrastructure & Embedded Components
------------------------------------

The following sections document components that are embedded directly
in this monorepo to support ProjT Launcher’s long-term operation.

This includes:

- Forked upstream libraries
- CI tooling and local evaluation helpers
- Automation bots and PR infrastructure

These sections exist primarily for maintainers, packagers, and
infrastructure reviewers.

If you are only interested in building or using the launcher,
you can safely skip to the License section.

Included Components Overview
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Compression & IO: bzip2, zlib, quazip
- Core data formats: libnbt++
- Automation & CI: Cloudflare Workers bot, CI scripts, evaluation tooling
- Packaging & distribution: Nix, program_info

Bzip2 bzip2/
------------

Lossless compression library used for BZip2 support.
This repository contains a fork of the upstream project and it now advances in its own tree; see upstream for the original source.
License: bzip2 license (BSD-like). See bzip2/COPYING.
Forked Source: https://gitlab.com/bzip2/bzip2

This is Bzip2/libbz2; a program and library for lossless, block-sorting data compression.

This document pertains to the Bzip2 feature development effort hosted on https://git.projecttick.com/projt-launcher.git/

The documentation here may differ from that on the Bzip2 1.1 project page maintained by Micah Snyder on https://gitlab.com/bzip2/bzip2
The documentation here may differ from that on the Bzip2 1.0.x project page
maintained by Mark Wielaard on https://sourceware.org/bzip2/

Copyright (C) 1996-2010 Julian Seward <[email protected]>

Copyright (C) 2019-2020 Federico Mena Quintero <[email protected]>

Copyright (C) 2021-2025 Micah Snyder https://gitlab.com/micahsnyder

Copyright (C) 2025 YongDo-Hyun https://github.com/YongDo-Hyun

Copyright (C) 2025 grxtor https://github.com/grxtor

Please read the WARNING section, DISCLAIMER and PATENTS sections in this file for important information.
This program is released under the terms of the license contained in the bzip2/COPYING file.
This version is fully compatible with the previous public releases.
Complete documentation is available in Postscript form manual.ps,
PDF manual.pdf or HTML manual.html  A plain-text version of the
manual page is available as bzip2.txt

Contributing to Bzip2's development
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Bzip2 project is hosted on GitHub for feature development work. It can be found at https://git.projecttick.org.tr
Changes to be included in the next feature version are committed to the develop branch. Feature releases are maintained
in release-X.Y.Z branches. Long-term feature and experimental development will occur in feature branches.
Feature branches are unstable. Feature branches may be rebased and force-pushed on occasion to keep them up-to-date and
to resolve merge conflicts. The `rustify` branch is a feature branch that represents an effort to
gradually port Bzip2 to https://www.rust-lang.org

Report a Bug
~~~~~~~~~~~~

Please report bugs via Mailing Lists
Before you create a new issue, please verify that no one else has already
reported the same issue.

Compiling Bzip2 and libbz2
~~~~~~~~~~~~~~~~~~~~~~~~~~

Please see the bzip2/COMPILING file for details.
This includes instructions for building using Meson or CMake.

WARNING
~~~~~~~

This program and library (attempts to) compress data by performing several
non-trivial transformations on it. Unless you are 100% familiar with *all* the
algorithms contained herein, and with the consequences of modifying them, you
should NOT meddle with the compression or decompression machinery.
Incorrect changes can and very likely *will* lead to disastrous loss of data.
Please contact the maintainers if you want to modify the algorithms.

DISCLAIMER
~~~~~~~~~~

I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE USE OF THIS
PROGRAM/LIBRARY, HOWSOEVER CAUSED.

Every compression of a file implies an assumption that the compressed file can
be decompressed to reproduce the original. Great efforts in design, coding and
testing have been made to ensure that this program works correctly.
However, the complexity of the algorithms, and, in particular, the presence of
various special cases in the code which occur with very low but non-zero
probability make it impossible to rule out the possibility of bugs remaining in
the program.

DO NOT COMPRESS ANY DATA WITH THIS PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT
THE POSSIBILITY, HOWEVER SMALL, THAT THE DATA WILL NOT BE RECOVERABLE.

That is not to say this program is inherently unreliable.
Indeed, I very much hope the opposite is true.
Bzip2/libbz2 has been carefully constructed and extensively tested.

PATENTS
~~~~~~~

To the best of my knowledge, Bzip2/libbz2 does not use any patented algorithms.
However, I do not have the resources to carry out a patent search.
Therefore I cannot give any guarantee of the above statement.

Maintainers
~~~~~~~~~~~

- Micah Snyder — upstream feature development (historical)
- YongDo-Hyun — ProjT Launcher fork maintenance

Quazip quazip/
--------------

Forked Source: https://github.com/stachenov/quazip
Local docs: quazip/QuaZip-1.x-migration

QuaZip is the C++ wrapper for Gilles Vollant's ZIP/UNZIP package
(AKA Minizip) using Qt library.

If you need to write files to a ZIP archive or read files from one
using QIODevice API, QuaZip is exactly the kind of tool you need.

See https://projtlauncher.projecttick.org.tr/wiki/ for details.

Want to report a bug or ask for a feature? Please contact via Mailing Lists.
Want to fix a bug or implement a new feature? See CONTRIBUTING
You're a package maintainer and want to update to QuaZip 1.0? Read quazip/QuaZip-1.x-migration

Copyright notice:

Copyright (C) 2005-2020 Sergey A. Tachenov and contributors
Distributed under LGPL, full details in the quazip/COPYING file.
Original ZIP package is copyrighted by Gilles Vollant, see
quazip/(un)zip.h files for details, but basically it's the zlib license.

Build
~~~~~

Dependencies
^^^^^^^^^^^^

You need at least the following dependencies:

- Qt6 or Qt5 (searched in that order)

Linux
^^^^^

Commands:

sudo apt-get install libbz2-dev
cmake -B build
cmake --build build

Windows
^^^^^^^

When using Qt online installer on Windows with MSVC, make sure to select the box for MSVC 20XY 64-bit and under additional libraries, select Qt 5 Compatibility Module.
Finally, add C:\Qt\6.8.2\msvc20XY_64 to your PATH.

If you don't use a package manager you will have to add library and include directories to your PATH or specify them with CMAKE_PREFIX_PATH.
Qt is not installed as a dependency of either vcpkg or conan.

x64
^^^

Using vcpkg

Commands:

cmake --preset vcpkg
cmake --build build --config Release

Using conan v2

Commands:

conan install . -of build -s build_type=Release -o *:shared=False --build=missing
cmake --preset conan
cmake --build build --config Release

x86
^^^

Only Qt5 is tested on x86.

Using vcpkg

Commands:

cmake --preset vcpkg_x86
cmake --build build --config Release

Using conan v2

Commands:

conan install . -of build -s build_type=Release -s:h arch=x86 -o *:shared=False --build=missing
cmake --preset conan_x86
cmake --build build --config Release

Additional build options
~~~~~~~~~~~~~~~~~~~~~~~~

If you built Qt from source and installed it, you might need to tell CMake where to find it, for example: -DCMAKE_PREFIX_PATH="/usr/local/Qt-6.8.2".  
Alternatively, if you did not install the source build it might look something like: -DCMAKE_PREFIX_PATH="/home/you/qt-everywhere-src-6.8.2/qtbase/lib/cmake".  
Replace qtbase if you used a custom prefix at configure step. Qt installed through Linux distribution packages or official Qt online installer should be detected automatically.
CMake is used to configure and build the project. A typical configure, build, install and clean is shown below.

Commands:

cmake -B build -DQUAZIP_QT_MAJOR_VERSION=6 -DBUILD_SHARED_LIBS=ON -DQUAZIP_ENABLE_TESTS=ON
cmake --build build --config Release
sudo cmake --install build
cd build
ctest --verbose -C Release
cmake --build . --target clean

CMake options

QUAZIP_QT_MAJOR_VERSION: Specifies which major Qt version should be searched for (6 or 5). By default it tries to find the most recent.
BUILD_SHARED_LIBS: Build QuaZip as a shared library. Default: ON
QUAZIP_LIB_FILE_NAME: Specifies output libname. quazip<quazip-version>-qt<qt-version>
QUAZIP_INSTALL: Enable installation Default: ON
QUAZIP_USE_QT_ZLIB: Use Qt's bundled zlib instead of system zlib (not recommended). Qt must be built with -qt-zlib and -static. Incompatible with BUILD_SHARED_LIBS=ON. Default: OFF
QUAZIP_ENABLE_TESTS: Build QuaZip tests Default: OFF
QUAZIP_BZIP2: Enable BZIP2 compression Default: ON
QUAZIP_BZIP2_STDIO: Output BZIP2 errors to stdio when BZIP2 compression is enabled Default: ON
QUAZIP_ENABLE_QTEXTCODEC: Set to OFF to explicitely disable the use of QTextCodec on Qt6 even if Core5Compat is available. This uses QStringConverter: https://doc.qt.io/qt-6/qstringconverter.html in the background with less supported encodings. Default: ON

Zlib zlib/
----------

Zlib is a general-purpose, lossless data-compression library used for
ZIP and GZip functionality.

This repository contains a maintained fork of the upstream zlib project.
The fork exists to allow controlled integration, CI validation, and
long-term maintenance within the ProjT Launcher monorepo.

- License: zlib license (see zlib/LICENSE)
- Upstream project: https://zlib.net
- Upstream source: https://github.com/madler/zlib
- Fork base version: 1.3.1.2

Fork policy
~~~~~~~~~~~

This fork aims to stay as close to upstream as possible.

- Upstream releases are periodically reviewed and merged.
- Changes are limited to build integration, CI compatibility,
  or clearly documented fixes.
- Functional divergence from upstream is avoided unless required.

Any deviations from upstream behavior are documented explicitly.

Documentation
~~~~~~~~~~~~~

- API reference: zlib/zlib.h
- FAQ: zlib/FAQ
- Change history: zlib/ChangeLog

Build integration
~~~~~~~~~~~~~~~~~

Zlib is built as part of the ProjT Launcher build.
Upstream build systems are preserved for reference, but the primary
build path is integrated into the monorepo tooling.

For upstream-specific build instructions, see https://zlib.net.

Licensing
~~~~~~~~~

Zlib is licensed under the zlib license.
The full license text is included unmodified in zlib/LICENSE.

Original work:
Copyright © 1995–2025
Jean-loup Gailly, Mark Adler

Modifications:
Copyright © 2026
Project Tick contributors

JavaCheck javacheck/
---------------------

A very simple program to print provided system properties.

Each argument is printed out as {arg}={System.getProperty(arg)} If any properties are null,
they will not be printed and the program will exit with code 1.

libnbt++ 3 libnbtplusplus/
--------------------------

This repository includes libnbt++ 3, the currently maintained version
used by ProjT Launcher.

Earlier versions (libnbt++ and libnbt++2) are documented here for historical
context only and are not used directly.

See forked https://github.com/PrismLauncher/libnbtplusplus

libnbt++ is a free C++ library for Minecraft's file format Named Binary Tag
(NBT). It can read and write compressed and uncompressed NBT files and
provides a code interface for working with NBT data.

libnbt++ 2 is a remake of the old libnbt++ library with the goal of making it
more easily usable and fixing some problems. The old libnbt++ especially
suffered from a very convoluted syntax and boilerplate code needed to work
with NBT data.

libnbt++ 3 is a remake of the old libnbt++ 2 library with the goal of fixing some
problems. The old libnbt++2 especially suffered from a very convoluted syntax and
boilerplate code needed to work with NBT data.

Building
~~~~~~~~

This project uses CMake for building. Ensure you have CMake installed.

Prerequisites
^^^^^^^^^^^^^

- C++11 compatible compiler
- CMake 3.15 or later
- ZLIB (optional, for compressed NBT support)

Build Steps
^^^^^^^^^^^

1. Clone the repository with this commands:

git clone https://github.com/Project-Tick/ProjT-Launcher.git
cd ProjT-Launcher/libnbtplusplus

2. Create a build directory with this commands:

mkdir build
cd build


3. Configure with CMake with this commands:

   cmake ..

   Options:
   - NBT_BUILD_SHARED=OFF (default): Build static library
   - NBT_USE_ZLIB=ON (default): Enable zlib support
   - NBT_BUILD_TESTS=ON (default): Build tests

4. Build with this commands:

   cmake --build .

5. Install with this commands (optional):

   cmake --install .

Usage
~~~~~

Include the headers and link against the library.

Example
^^^^^^^

#include <nbt_tags.h>
#include <fstream>
#include <iostream>

int main() {
    // Read an NBT file
    std::ifstream file("example.nbt", std::ios::binary);
    nbt::tag_compound root = nbt::io::read_compound(file).first;

    // Access data
    std::cout << root["some_key"].as<nbt::tag_string>() << std::endl;

    return 0;
}

License
~~~~~~~

This project is licensed under the GNU General Public License v3.0. See the libnbtplusplus/COPYING file for details.

launcherjava launcherjava/
--------------------------

Java launcher part for Minecraft.

It does the following:

- Waits for a launch script on stdin.
- Consumes the launch script you feed it.
- Proceeds with launch when it gets the launcher command.

If abort is sent, the process will exit.

This means the process is essentially idle until the final command is sent. You can, for example, attach a profiler before you send it.

The standard and legacy launchers are available.

- standard can handle launching any Minecraft version, at the cost of some extra features legacy enables (custom window icon and title).
- legacy is intended for use with Minecraft versions < 1.6 and is deprecated.

Example (some parts have been censored):

mod legacyjavafixer-1.0
mainClass net.minecraft.launchwrapper.Launch
param --username
param CENSORED
param --version
param ProjT Launcher
param --gameDir
param /home/peterix/minecraft/FTB/17ForgeTest/minecraft
param --assetsDir
param /home/peterix/minecraft/mmc5/assets
param --assetIndex
param 1.7.10
param --uuid
param CENSORED
param --accessToken
param CENSORED
param --userProperties
param {}
param --userType
param mojang
param --tweakClass
param cpw.mods.fml.common.launcher.FMLTweaker
windowTitle ProjT Launcher: 172ForgeTest
windowParams 854x480
userName CENSORED
sessionId token:CENSORED:CENSORED
launcher standard

Available under GPL-3.0 see launcherjava/LICENSE (with classpath exception), sublicensed from its original Apache-2.0 codebase

ProjT Launcher Nix Packaging nix/
---------------------------------

Installing a development release (flake)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Installing the package directly
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

After adding github:Project-Tick/ProjT-Launcher to your flake inputs, you can access the flake's packages output.

Example:

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    projtlauncher = {
      url = "github:Project-Tick/ProjT-Launcher";

      # Optional: Override the nixpkgs input of projtlauncher to use the same revision as the rest of your flake
      # Note that this may break the reproducibility mentioned above, and you might not be able to access the binary cache
      #
      # inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs =
    { nixpkgs, projtlauncher, ... }:
    {
      nixosConfigurations.foo = nixpkgs.lib.nixosSystem {
        modules = [
          ./configuration.nix

          (
            { pkgs, ... }:
            {
              environment.systemPackages = [ projtlauncher.packages.${pkgs.system}.projtlauncher ];
            }
          )
        ];
      };
    };
}

Using the overlay
^^^^^^^^^^^^^^^^^

Alternatively, if you don't want to use our `packages` output, you can add our overlay to your nixpkgs instance.
This will ensure ProjT Launcher is built with your system's packages.

WARNING:
Depending on what revision of nixpkgs your system uses, this may result in binaries that differ from the above `packages` output
If this is the case, you will not be able to use the binary cache

Example:

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    projtlauncher = {
      url = "github:Project-Tick/ProjT-Launcher";

      # Optional: Override the nixpkgs input of projtlauncher to use the same revision as the rest of your flake
      # Note that this may break the reproducibility mentioned above, and you might not be able to access the binary cache
      #
      # inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs =
    { nixpkgs, projtlauncher, ... }:
    {
      nixosConfigurations.foo = nixpkgs.lib.nixosSystem {
        modules = [
          ./configuration.nix

          (
            { pkgs, ... }:
            {
              nixpkgs.overlays = [ projtlauncher.overlays.default ];

              environment.systemPackages = [ pkgs.projtlauncher ];
            }
          )
        ];
      };
    };
}

Installing the package ad-hoc (nix shell, nix run, etc.)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can simply call the default package of this flake.

Example:

nix run github:Project-Tick/ProjT-Launcher

nix shell github:Project-Tick/ProjT-Launcher

nix profile install github:Project-Tick/ProjT-Launcher

Installing a development release (without flakes)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Installing the package directly (fetchTarball)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We use flake-compat to allow using this Flake on a system that doesn't use flakes.

Example:

{ pkgs, ... }:
{
  environment.systemPackages = [
    (import (
      builtins.fetchTarball "https://github.com/Project-Tick/ProjT-Launcher/archive/develop.tar.gz"
    )).packages.${pkgs.system}.projtlauncher
  ];
}

Using the overlay (fetchTarball)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Alternatively, if you don't want to use our packages output, you can add our overlay to your instance of nixpkgs.
This results in ProjT Launcher using your system's libraries

Example:

{ pkgs, ... }:
{
  nixpkgs.overlays = [
    (import (
      builtins.fetchTarball "https://github.com/Project-Tick/ProjT-Launcher/archive/develop.tar.gz"
    )).overlays.default
  ];

  environment.systemPackages = [ pkgs.projtlauncher ];
}

Installing the package ad-hoc (nix-env)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can add this repository as a channel and install its packages that way.

Example:

nix-channel --add https://github.com/Project-Tick/ProjT-Launcher/archive/develop.tar.gz projtlauncher

nix-channel --update projtlauncher

nix-env -iA projtlauncher.projtlauncher

Package variants
~~~~~~~~~~~~~~~~

Both Nixpkgs and this repository offer the following packages:

- projtlauncher - The preferred build, wrapped with everything necessary to run the launcher and Minecraft
- projtlauncher-unwrapped - A minimal build that allows for advanced customization of the launcher's runtime environment

Customizing wrapped packages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The wrapped package (projtlauncher) offers some build parameters to further customize the launcher's environment.

The following parameters can be overridden:

- additionalLibs (default: [ ]) Additional libraries that will be added to LD_LIBRARY_PATH
- additionalPrograms (default: [ ]) Additional libraries that will be added to PATH
- controllerSupport (default: isLinux) Turn on/off support for controllers on Linux (macOS will always have this)
- gamemodeSupport (default: isLinux) Turn on/off support for https://github.com/FeralInteractive/gamemode on Linux
- jdks (default: [ jdk21 jdk17 jdk8 ]) Java runtimes added to PROJTLAUNCHER_JAVA_PATHS variable
- msaClientID (default: null, requires full rebuild!) Client ID used for Microsoft Authentication
- textToSpeechSupport (default: isLinux) Turn on/off support for text-to-speech on Linux (macOS will always have this)

ProjT Launcher Program Info program_info/
-----------------------------------------

This is ProjT Launcher's program info which contains information about:

- Application name and logo (and branding in general)
- Various URLs and API endpoints
- Desktop file

Third-party libraries
---------------------

This section lists third‑party/external libraries required by other components in this repository. Each entry includes the library name, its purpose in the repo, license information, and a source URL.

gamemode
~~~~~~~~

A performance optimization daemon.

See https://github.com/FeralInteractive/gamemode.

BSD-3-Clause licensed

LocalPeer
~~~~~~~~~

Library for making only one instance of the application run at all times.

BSD licensed, derived from https://github.com/qtproject/qt-solutions/tree/master/qtsingleapplication.

Changes are made to make the code more generic and useful in less usual conditions.

murmur2
~~~~~~~

Canonical implementation of the murmur2 hash, taken from https://github.com/aappleby/smhasher

Public domain (the author disclaimed the copyright).

rainbow
~~~~~~~

Color functions extracted from https://inqlude.org/libraries/kguiaddons.html Used for adaptive text coloring.

Available either under LGPL-2.1-or-later

systeminfo
~~~~~~~~~~

A ProjT Launcher-specific library for probing system information.

Apache-2.0

qdcss
~~~~~

A quick and dirty css parser, used by NilLoader to store mod metadata.

Translated (and heavily trimmed down) from https://github.com/unascribed/NilLoader/blob/trunk/website/main/java/nilloader/api/lib/qdcss/QDCSS.java from NilLoader

Licensed under LGPL-3.0.

License for ProjT Launcher
--------------------------

Code: GPL-3.0 see LICENSE

Assets: CC BY-SA 4.0

License for Website
-------------------

Code: AGPL-3.0 see website/LICENSE
Assets: CC BY-SA 4.0

License for Metadata Generator
------------------------------

Code: MS-PL see meta/LICENSE

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

Maintained by the Project Tick contributors.