Skip to content

Universal Minecraft Client Mod-Loader, written in Kotlin

License

Notifications You must be signed in to change notification settings

Weave-MC/Weave-Loader

Repository files navigation

title

Weave Loader, the Universal Minecraft Mod Loader

Weave Loader is a tool designed to simplify the process of modding Minecraft. It allows developers to easily create mods by providing a simple and intuitive API for interacting with Minecraft's codebase, while supporting injection into clients that are somewhat closed-off to developers.

Supported Clients / Versions

Supported ClientsSupported Versions
Client Supported
Vanilla
Forge
Lunar
Badlion
Feather
Labymod
Version Supported
1.7
1.8
1.12
1.16
1.17
1.18
1.19
1.20

Installation

To install Weave-Loader, you can either download a pre-built release from the releases page, or build it yourself from source.

Building with Gradle

  • First clone the project with Git then cd into the project directory:
git clone --recursive https://github.com/Weave-MC/Weave-Loader
cd Weave-Loader

You then need to give permission to the Gradle wrapper and run the agent task. This can be done a bit differently depending on your operating system:

UN*X (Linux, BSDs, macOS, etc.)
chmod +x ./gradlew
./gradlew agent
Windows
.\gradlew.bat agent

Usage

To use Weave-Loader, you have two options:

  • Use Weave-Manager to handle the process of attaching Weave to your preferred Minecraft client automatically.
  • Manually add the Weave-Loader agent mentioned in the previous step to the JVM arguments when launching Minecraft.
    • You will need to include the following argument: -javaagent:$PATH_TO_AGENT

Weave will automatically load mods from ~/.weave/mods/.

Contributing

We welcome contributions from anyone interested in improving Weave-Loader. If you find a bug or have an idea for a new feature, feel free to submit a pull request.


Weave-Loader is licensed under the GNU General Public License v3.0.