PrismLauncher/libraries/README.md
seth f7ffbcca6c
chore(docs): correct markdownlint warnings
Signed-off-by: seth <getchoo@tuta.io>
2023-07-26 14:49:09 -04:00

3.9 KiB

Third-party libraries

This folder has third-party or otherwise external libraries needed for other parts to work.

filesystem

Gulrak's implementation of C++17 std::filesystem for C++11 /C++14/C++17/C++20 on Windows, macOS, Linux and FreeBSD.

See github repo.

MIT licensed.

gamemode

A performance optimization daemon.

See github repo.

BSD-3-Clause licensed

cmark

The C reference implementation of CommonMark, a standardized Markdown spec.

See github_repo.

BSD2 licensed.

javacheck

Simple Java tool that prints the JVM details - version and platform bitness.

Do what you want with it. It is so trivial that noone cares.

Katabasis

Oauth2 library customized for Microsoft authentication.

This is a fork of the O2 library.

MIT licensed.

launcher

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 Prism 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 Prism Launcher: 172ForgeTest
windowParams 854x480
userName CENSORED
sessionId token:CENSORED:CENSORED
launcher standard

Available under GPL-3.0-only (with classpath exception), sublicensed from its original Apache-2.0 codebase

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.

See github repo.

Available either under LGPL version 3 or later.

LocalPeer

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

BSD licensed, derived from 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 SMHasher.

Public domain (the author disclaimed the copyright).

quazip

A zip manipulation library.

LGPL 2.1 with linking exception.

rainbow

Color functions extracted from KGuiAddons. Used for adaptive text coloring.

Available either under LGPL version 2.1 or later.

systeminfo

A Prism Launcher-specific library for probing system information.

Apache 2.0

tomlplusplus

A TOML language parser. Used by Forge 1.14+ to store mod metadata.

See github repo.

Licenced under the MIT licence.

qdcss

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

Translated (and heavily trimmed down) from the original Java code from NilLoader

Licensed under LGPL version 3.