Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/unascribed/nilloader

The universally-compatible ultra-light mod loader.
https://github.com/unascribed/nilloader

Last synced: 17 days ago
JSON representation

The universally-compatible ultra-light mod loader.

Awesome Lists containing this project

README 

        



# NilLoader



NilLoader (ØL or 0L) is a minimal, easy-to-install, application-independent system for applying

runtime patches to programs written in Java, compatible with any launcher that allows you to modify

JVM arguments.



It's based on the native Java agent system, but provides a comprehensive and convenient API for

defining class patches and entrypoints on top of it. It additionally provides a system for working

with obfuscated environments, without forcing you to write code using obfuscated names. (Note that

NilLoader does not provide a "high-level" bytecode patching system like Mixin; you have to write

raw bytecode patches using Mini or ASM directly.)



A NilLoader mod includes a complete copy of NilLoader within itself, allowing a NilLoader mod to be

used directly as a Java agent. However, you can also load NilLoader alone as a Java agent, and it

will discover NilLoader-compatible jars in a subdirectory called `mods`, or `nilmods` if another

loader is being layered with NilLoader and is confused by the presence of NilLoader jars in its

`mods` directory. Copies of NilLoader contained in these mods will be ignored by the class loader,

avoiding version conflicts.



## NilLoader + Minecraft



NilLoader was primarily designed for Minecraft, like a lot of Java bytecode patching frameworks. In

a Minecraft environment, it is compatible with all current and past loaders, and can patch any

version of the game from Cave Game Test to the latest snapshot. However, since NilLoader is so

generic, it does not come with many conveniences that other loaders do, such as intermediate

mappings, cross-version compatibility, or any API of any kind. NilLoader lets you do two things:

patch classes, and get told when the JVM starts before anything else has run.



However, given these two possibilities, you can do just about anything else you want. Note that

NilLoader is not a replacement for Fabric or Forge, it is an additional option for supporting weird

versions or doing things the other loaders won't let you do. Someone could very well build an entire

API on top of NilLoader, but that someone will not be me, and it's not something I intend to have

happen.



NilLoader has its origins in the cross-version patching framework created for Ears, used for its

ports to Beta 1.7, early versions of Forge, NFC, etc. That is, more or less, its intended purpose.



## Using NilLoader



More comprehensive docs coming soon, but for now, check out [NilExample](https://git.sleeping.town/unascribed/NilExample)

to write mods, and use [this Prism Launcher component JSON](https://repo.sleeping.town/com/unascribed/nilloader/1.3.3/nilloader-1.3.3-prism.json)

to install it. (Click "Add Empty" under versions, enter "NilLoader" and

"com.unascribed.nilloader", then click Edit on the right, and replace the contents

of the file it opens with that JSON.)



For other launchers, download the latest NilLoader from releases,

put it in your .minecraft, rename it to `NilLoader.jar`, and add

`-javaagent:NilLoader.jar` to your JVM arguments.