Weed
WeedDev

Minecraft Java 26.1.2

Generate a Weed mod template.

Fill the basics, choose the starter hooks, and download a ready-to-build Weed mod project.

Template

Mod Details

Docs

Build Weed mods without guessing.

Search the essentials: entrypoints, manifests, events, logging, packaging, install paths, and the current mixin status.

01Setup

Quickstart

Generate the zip, extract it, build Weed once, then build the generated mod project.

.\gradlew.bat --no-daemon buildAll
.\gradlew.bat build packageWeedMod
02Metadata

manifest.weed

The manifest tells Weed how to discover your mod, which Minecraft version it targets, and what class to load.

{
  "id": "my_mod",
  "minecraftVersion": "26.1.2",
  "entrypoint": "com.example.MyMod"
}
03Java API

Entrypoint

Implement `WeedMod`, keep your setup inside `onInitialize`, and register event listeners through `ModContext`.

public final class MyMod implements WeedMod {
  public void onInitialize(ModContext context) {
    context.getEventBus().register(this);
  }
}
APIReference

Full API Reference

Open the searchable API document for every public interface, event, metadata view, logger, and mixin annotation.

Open API docs
04Hooks

Events

Use `@SubscribeEvent` for lifecycle, tick, player, and block break hooks exposed by the current Weed runtime.

@SubscribeEvent
public void onTick(TickEvent event) {
  logger.debug("Tick " + event.getTick());
}
05Runtime

Logging

Weed writes `.txt` logs under `.minecraft/logs` and exposes terminal logging from the Weed Settings button.

%APPDATA%\.minecraft\logs\weed-*.txt
06Jar

Packaging

The template creates a jar in `build/weed-dist`. Copy it into the Weed mods folder before launching.

%APPDATA%\.minecraft\mods\weed
07Experimental

Mixins

The generator can scaffold a mixin config and marker class. Runtime mixin support is still experimental in this branch.

"mixins": ["mixin.my_mod.json"]

Version Registry

Synced from GitHub branches.

Each branch can publish a `versions.web.weed` file. The generator scans branches, reads that file, and builds the selectable Minecraft, Weed API, and loader version lists automatically.

Loading GitHub branch versions...

Steps

What you need to do

  1. Generate and extract the template zip.
  2. Build Weed first with `.\gradlew.bat --no-daemon buildAll` in the Weed repo.
  3. Open the generated mod folder and run `.\gradlew.bat build packageWeedMod`.
  4. Copy the generated jar from `build/libs` or `build/weed-dist` into `.minecraft/mods/weed`.
  5. Launch Weed and check `.minecraft/logs/weed-*.txt` for your mod id.

GitHub Pages setup: push this repo, open GitHub repository settings, go to Pages, select the `26.1.2` branch and `/docs` folder, then save. The site will be served from the Pages URL GitHub shows you.

Open full generator docs