From a22c4ada3bfd9254b98b4498a58340aa40cc8231 Mon Sep 17 00:00:00 2001 From: HerozDotExe Date: Sat, 23 May 2026 12:11:01 +0200 Subject: [PATCH] docs: add infos about auth and some acknowledgments in readme --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3189410..a2bcf8a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A typescript library to install and launch minecraft with or without modloaders. -# Features +## Features * Supports installing and launching **vanilla** from 1.0 to 26.1.2 * Supports installing and launching **forge** from 1.7.10 to 26.1.2 @@ -11,8 +11,7 @@ A typescript library to install and launch minecraft with or without modloaders. * Can install and launch **modrinth** modpacks * Uses **concurrents downloads** to speed up installation process - -## Example +## Basic Example You can use this code to install and launch minecraft 1.21.11 with offline auth. This will also automatically download fitting java binaries. @@ -59,3 +58,15 @@ p.stderr.on("data", (d: Buffer) => { ``` > You can look in the tests folder to see more examples showing how to use nlk with fabric, forge, neoforge, and modrinth's modpacks. + +## Authentification +You can use [prismarine-auth](https://github.com/PrismarineJS/prismarine-auth) or [MSMC](https://github.com/Hanro50/MSMC) to authentificate with a microsoft account. +*See src/utils/types.ts for Auth type.* + +You can use offlineAuth during development. + +## Acknowledgments + +This project was inspired by [mclc](https://github.com/Pierce01/MinecraftLauncher-core). + +`shell.nix` is a modification of [Tomate0613's](https://github.com/Tomate0613/launcher-core/blob/main/flake.nix).