VisceraLib

About

Multiproject library for general ease of development within a multiloader environment. This library can be used in single loader projects as well for its unique APIs, but it is primarily for multiloader.

VisceraLib is meant to provide:

• Abstraction between modloader APIs.
• Implementations of Minecraft or modloader features for easier development.
• General cleanliness of code by handling things mostly in common.

This project is licensed under MIT-0

Note

This is primarily created for my own personal use and I feel it is only fair to hold little restrictions for others in such context.
This is meant to help me, and if other projects want to use it to help them in whatever way possible, then it has succeeded.

Usage

Warning

This library has yet to be released.

Here's how to import VisceraLib into your project:

Multiloader

Architectury Multiloader:

Kotlin DSL

modImplementation("net.electrisoma.visceralib:visceralib:${visceralib_version}-common")

Groovy DSL

modImplementation "net.electrisoma.visceralib:visceralib:${visceralib_version}-common"

or

Kotlin DSL

listOf(
    "core",
    "registration-api-v1",
    "item-hooks-v1"
).forEach { module ->
    "net.electrisoma.visceralib:visceralib-$module:${visceralib_version}-common".let {
        modImplementation(it)
    }
}

Groovy DSL

Set<String> modules = [
        "core",
        "registration-api-v1",
        "item-hooks-v1"
]

modules.each {
    def dep = "net.electrisoma.visceralib:visceralib-${it}:${visceralib_version}-common"
    modImplementation(dep)
}

Jared's Multiloader Template:

Kotlin DSL

implementation("net.electrisoma.visceralib:visceralib:${visceralib_version}-common")

Groovy DSL

implementation "net.electrisoma.visceralib:visceralib:${visceralib_version}-common"

or

Kotlin DSL

listOf(
    "core",
    "registration-api-v1",
    "item-hooks-v1"
).forEach { module ->
    "net.electrisoma.visceralib:visceralib-$module:${visceralib_version}-common".let {
        implementation(it)
    }
}

Groovy DSL

Set<String> modules = [
        "core",
        "registration-api-v1",
        "item-hooks-v1"
]

modules.each {
    def dep = "net.electrisoma.visceralib:visceralib-${it}:${visceralib_version}-common"
    implementation(dep)
}

Fabric

Loom

Kotlin DSL

modImplementation("net.electrisoma.visceralib:visceralib:${visceralib_version}-fabric")

Groovy DSL

modImplementation "net.electrisoma.visceralib:visceralib:${visceralib_version}-fabric"

Kotlin DSL

listOf(
    "core",
    "registration-api-v1",
    "item-hooks-v1"
).forEach { module ->
    "net.electrisoma.visceralib:visceralib-$module:${visceralib_version}-fabric".let {
        modImplementation(it)
        include(it)
    }
}

Groovy DSL

Set<String> modules = [
        "core", 
        "registration-api-v1", 
        "item-hooks-v1"
]

modules.each {
    def dep = "net.electrisoma.visceralib:visceralib-${it}:${visceralib_version}-fabric"
    modImplementation(dep)
    include(dep)
}

NeoForge

MDG

Kotlin DSL

implementation("net.electrisoma.visceralib:visceralib:${visceralib_version}-neoforge")

Groovy DSL

implementation "net.electrisoma.visceralib:visceralib:${visceralib_version}-neoforge"

Kotlin DSL

listOf(
    "core",
    "registration-api-v1",
    "item-hooks-v1"
).forEach { module ->
    "net.electrisoma.visceralib:visceralib-$module:${visceralib_version}-neoforge".let {
        implementation(it)
        jarJar(it)
    }
}

Groovy DSL

Set<String> modules = [
        "core",
        "registration-api-v1",
        "item-hooks-v1"
]

modules.each {
    def dep = "net.electrisoma.visceralib:visceralib-${it}:${visceralib_version}-neoforge"
    implementation(dep)
    jarJar(dep)
}

Contributing

If you feel you have something to contribute then I would be happy to accept meaningful contributions for the sake of furthering this project.

Note

This section may receive updates with time.

Modules

Each of these modules has some amount of documentation attached to it via a README.md file (similar to the one you're reading right now). This is to keep things tidy and clean and to give a general concept of what's inside the module.

Note

This section will have all modules and associated README.md files documented for reference.

- VisceraLib Core

See VisceraLib Core README

- VisceraLib Item Hooks (v1)

See VisceraLib Item Hooks (v1) README

- VisceraLib Registration API (v1)

See VisceraLib Registration API (v1) README