meister1593 / annotated-di

Dependency Injection for Fabric mods

Annotated DI

Annotated DI adds Dependency Injection for Minecraft mods. It includes Guice for the basic DI system, and adds a custom annotation to allow easily setting up a DI system configured only by annotations.

Setup

To use this with your mod, include the following in build.gradle:

dependencies {
  modImplementation "dev.the-fireplace:Annotated-DI:${project.annotateddi_version}"
  annotationProcessor "dev.the-fireplace:Annotated-DI:${project.annotateddi_version}:processor"
}

And in gradle.properties:

annotateddi_version=<mod version>+<minecraft version>

After that, edit your fabric.mod.json to use di-main entrypoint and implement your main entrypoint with DIModInitializer instead of ModInitializer

Usage

A simple example of how the custom @Implementation annotation is used:

NetworkInterface.java

public interface NetworkInterface {
    ByteBuf getBuffer();
}

BufferFactory.java

@Implementation
public class BufferFactory implements NetworkInterface {
    @Override
    public ByteBuf getBuffer() {
        // do stuff
    }
}

SomeOtherFile.java (Using Constructor Injection)

public class SomeOtherFile {
    private final NetworkInterface networkInterface;
    
    @Inject
    public SomeOtherFile(NetworkInterface interface) {
        this.networkInterface = interface;
    }
    
    public void doStuff() {
        ByteBuf buffer = this.networkInterface.getBuffer();
    }
}

DiEntrypoint.java

public class DiEntrypoint implements DIModInitializer {
    public void onInitialize(Injector diContainer) {
        SomeOtherFile otherFile = diContainer.getInstance(SomeOtherFile.class);
        otherFile.doStuff();
    }
}

@Implementation annotation with multiple interfaces:

NetworkInterface.java

public interface NetworkInterface {
    ByteBuf getBuffer();
}

BufferFactory.java

@Implementation({NetworkInterface.class})
public class BufferFactory implements NetworkInterface, SomeOtherInterface {
    @Override
    public ByteBuf getBuffer() {
        // do stuff
    }
}

SomeOtherFile.java (Using Constructor Injection)

public class SomeOtherFile {
    private final NetworkInterface networkInterface;
    
    @Inject
    public SomeOtherFile(NetworkInterface interface) {
        this.networkInterface = interface;
    }
    
    public void doStuff() {
        ByteBuf buffer = this.networkInterface.getBuffer();
    }
}