Skip to content

Team-Immersive-Intelligence/ModworksProcessor

Repository files navigation

ModWorks Logo

Discord Jitpack Support me on Patreon Tests Passing

Description

ModWorks is an annotation processor and resource/code generator designed for minecraft mods, in particular our 1.12.2 addon to Immersive Engineering called Immersive Intelligence. In its current state the processor offers:

  • sounds.json file generation based on annotated SoundEvent variables
  • mcmod.info file generation based on data passed by gradle build script
  • json file generation for simple item models
  • json file generation for simple blockstates

Usage

ModWorks can be used as a part of Team II's Mod Setup Script Mk.4/5 or standalone.

To use ModWorks in a generic Minecraft Mod environment add

sourceSets.main.java.srcDirs+=['src/main/generated/java']
sourceSets.main.resources.srcDirs+=['src/main/generated/resources']

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    annotationProcessor 'com.github.Team-Immersive-Intelligence:ModworksProcessor:1.1.2'
    compileOnly 'com.github.Team-Immersive-Intelligence:ModworksProcessor:1.1.2'
}

compileJava {
    options.annotationProcessorGeneratedSourcesDirectory=project.file("src/main/generated")
    options.compilerArgs.addAll([
            '-Amodworks.modid=MODNAME', //MOD ID HERE
            '-Amodworks.resourcedir=resources', //RESOURCE FOLDER NAME
            '-Amodworks.javadir=java' //JAVA FOLDER NAME
    ])
}

to your build.gradle script.

To activate ModWorks in a Mod Setup Script Mk.4/5 environment change the ii_useModworksPreprocessor option to true.


In case you want to use it, please contact @Pabilo8 or another Team II member to get proper support, we're happy when someone wants to use our technology and will give support in integrating it.

Feel free to join the mod's Discord Server to have a chat with the devs and community.

Please report any bugs you find in the 'issues' tab.

About

Annotation Processor used to generate code and resources for our IE addons.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages