An open API service indexing awesome lists of open source software.

https://github.com/404setup/fnp-patcher

Optimize the network and provide additional support for Krypton Fabric.
https://github.com/404setup/fnp-patcher

fabric-mod krypton minecraft minecraft-mod minecraft-optimization

Last synced: 3 months ago
JSON representation

Optimize the network and provide additional support for Krypton Fabric.

Awesome Lists containing this project

README

          

# FNP Patcher

This is an extension mod for Krypton Fabric, ported from KryptonFNP.

$\color{Red}\Huge{\textbf{You should not include }}$
$\color{Red}\Huge{\textbf{the }}$
$\color{Gold}\Huge{\textbf{modified }}$
$\color{Red}\Huge{\textbf{Krypton Fabric }}$
$\color{Red}\Huge{\textbf{in your modpack!}}$

$\color{Red}\Huge{\textbf{Instead install both }}$
$\color{Red}\Huge{\textbf{Krypton Fabric and KryptonFNP }}$
$\color{Red}\Huge{\textbf{Patcher and give instructions}}$
$\color{Red}\Huge{\textbf{ on how to use them.}}$

## Feature

- More basic optimizations
- Support RecastLib (Velocity Native rewritten in Rust, compatible with Windows x64/arm64)

## Install as a Mod

Just install it normally.

In addition, KryptonFNP Patcher also includes a repair patch for Krypton Fabric, which will be automatically applied
when Krypton Fabric is detected to be installed. (You can turn it off manually)

## Installed as a patch for Krypton Fabric

KryptonFNP PatcherIn order to implement Krypton Patch, the patch must be executed in the following way:

1. Install Krypton Fabric and KyrptonFNP Patcher as a Mod
2. Enter the Mod installation directory
3. Open Terminal
4. Use command: `java -jar kryptonfnp_patcher.jar` (Please use actual file names!)
5. Done

This will replace the Velocity Native included in Krypton Fabric with a native library that mixes RecastLib with
Velocity Native.

## Warning

When performing the patch operation, you need to close the running game and make sure that no other processes are
occupying the Mods directory.

## Config

Add the following parameters to the Java startup parameters to control the mixin enablement:

| Parameter | Description | Default value | Configuration in file form |
|-------------------------------|-----------------------------------------------------------------------|---------------|----------------------------|
| krypton.loginVT | Enable Login VirtualThread optimization | true | Support |
| krypton.textFilterVT | Enable TextFilter VirtualThread optimization | true | Support |
| krypton.utilVT | Enable Util VirtualThread optimization | true | Support |
| krypton.bestVarLong | Enable VarLong optimization | true | Support |
| krypton.fix128 | Fix Krypton Fabric [128](https://github.com/astei/krypton/issues/128) | true | Support |
| velocity.natives-disable | Disable Native | false | Not supported |
| velocity.linux-recast-enabled | Enable RecastLib for Linux | false | Not supported |

example:

```shell
java -Dkrypton.loginVT=false -jar neoforge_launcher.jar
```

### Use env instead of jvm args

Some configuration items support using environment variables instead of jvm args.

| JVM ARGS | Environment Variable |
|-------------------------------|----------------------|
| velocity.linux-recast-enabled | ENABLE_LINUX_RECAST |

## Dependencies
- [Krypton Fabric](https://modrinth.com/mod/krypton) - Optional dependency. I put some optimizations here.
- [Resource Config API](https://modrinth.com/mod/resource-config-api) - Required dependencies. Configuration GUI and config file capabilities are provided by this mod.

## Translate
This doesn't take much time, you just need to tell me what language is missing.

It works in the Config GUI.

## License

This work has a restrictive license in addition to the original license to prevent some unexpected behavior,
see [404Setup Works Redistribution License](https://github.com/404Setup/404Setup/blob/main/LICENSE.md)