HerozDotExe/node-launcher-kit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add infos about auth and some acknowledgments in readme

Browse source
This commit is contained in:
HerozDotExe 2026-05-23 12:11:01 +02:00
parent e400af3993
commit a22c4ada3b
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -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).