Skip to content

Latest commit

 

History

History
141 lines (118 loc) · 5.1 KB

README.md

File metadata and controls

141 lines (118 loc) · 5.1 KB
Raw


αccessories

Maven metadata URL

Overview

Accessories is a Data-Driven Accessory mod for NeoForge and Fabric with emphasis on using a Common API for both platforms when possible

This API is based on the works of Curios and Trinkets with credit going to both TheIllusiveC4 and emilyploszaj for their work on Accessory mods for Minecraft.

Build Setup

Below is an example of various dependencies setups for platforms with the given repositories are all required for all accessories dependencies.

Groovy

repositories {
    maven { url 'https://maven.wispforest.io/releases' }
    maven { url 'https://maven.su5ed.dev/releases' }
    maven { url 'https://maven.fabricmc.net' }
    maven { url 'https://maven.shedaniel.me/' }
}

// Fabric
dependencies {
    modImplementation("io.wispforest:accessories-fabric:${project.accessories_version}")
}
//...

// Arch Common
dependencies {
    modImplementation("io.wispforest:accessories-common:${project.accessories_version}")
}
//...

// Arch NeoForge
dependencies {
    modImplementation("io.wispforest:accessories-neoforge:${project.accessories_version}")

    // Required due to issues with JIJ dependency resolving in arch or something
    forgeRuntimeLibrary("io.wispforest:endec:0.1.8")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.5")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.4")
}
//...

// NeoForge
dependencies {
    implementation("io.wispforest:accessories-neoforge:${project.accessories_version}")
}
//...

// Vanilla Gradle Common
dependencies {
    // Yarn Intermediary 
    compileOnly("io.wispforest:accessories-common:${project.accessories_version}")
    
    // Mojang Mappings
    compileOnly("io.wispforest:accessories-common:${project.accessories_version}-mojmap")
}

Kotlin DSL

 
repositories {
    maven("https://maven.wispforest.io/releases")
    maven("https://maven.su5ed.dev/releases")
    maven("https://maven.fabricmc.net")
    maven("https://maven.shedaniel.me/")
}

// Fabric
dependencies {
    modImplementation("io.wispforest:accessories-fabric:${properties["accessories_version"]}")
}
//...

// Arch Common
dependencies {
    modImplementation("io.wispforest:accessories-common:${properties["accessories_version"]}")
}
//...

// Arch NeoForge
dependencies {
    modImplementation("io.wispforest:accessories-neoforge:${properties["accessories_version"]}")

    // Required due to issues with JIJ dependency resolving in arch or something
    forgeRuntimeLibrary("io.wispforest:endec:0.1.8")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.5")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.4")
}
//...

// NeoForge
dependencies {
    implementation("io.wispforest:accessories-neoforge:${properties["accessories_version"]}")
}
//...

// Vanilla Gradle Common
dependencies {
    // Yarn Intermediary 
    compileOnly("io.wispforest:accessories-common:${properties["accessories_version"]}")

    // Mojang Mappings
    compileOnly("io.wispforest:accessories-common:${properties["accessories_version"]}-mojmap")
}

Features

  • Compatibility Layers with existing Accessory Mods like Curios and Trinkets
  • Full Support for NBT-based Accessories (More Info on Wiki {TODO: ADD LINK TO WIKI})
  • Existing API Events for Piglin Neutral Items, Enderman Masks, Looting Adjustments, Fortune Adjustments, and Snow Walking Ability.
  • Unique Slot API for Mod Specific Accessories (More Info on Wiki {TODO: ADD LINK TO WIKI})