How jack-sibley/slimeorigin works
Project Type and Purpose
• This is a single-module Minecraft mod (Fabric loader) that extends the Origins Mod by adding a “Slime” origin.
• It’s written in Java, built with Gradle, uses the Fabric API and Fabric Mixin framework, and is data-driven via JSON definitions (origins, powers).
File Structure Analysis
• Top-level build files (build.gradle, settings.gradle, gradlew, etc.) define the Gradle build and Fabric tooling.
• src/main/java/…/slimeorigin:
• Slimeorigin.java – the common (shared) entry point; registers origins/powers.
• client/SlimeoriginClient.java – client-only initialization (e.g., renderers, keybinds).
• mixin/… – Mixin classes (MixinBlock.java, MixinLivingEntity.java, MixinSlimeBlock.java) that inject behavior into base Minecraft classes.
• src/main/resources:
• fabric.mod.json – mod metadata for Fabric loader (mod ID, entry points).
• slimeorigin.mixins.json – Mixin configuration for runtime class weaving.
• assets/slimeorigin – optional textures or locale files (empty here).
• data/origins/origin_layers/origin.json – data pack layering for Origins Mod.
• data/slimeorigin/origins/*.json – the slime origin definition.
• data/slimeorigin/powers/*.json – power definitions (jump, bounce, slime skin, etc.).
README Insights
• Confirms it’s an archived “slime origin” extension to the Origins Mod.
• No further architectural notes, but mentions that code is largely undocumented and public domain.
Diagramming the Architecture
a. Main Components
• Gradle Build System
• Fabric Mod Loader & API
• Mixin Framework
• Minecraft Game Engine (client and server)
• Origins Mod API (dependency)
• Slimeorigin Mod Jar
– Common entrypoint (Slimeorigin.java)
– Client entrypoint (SlimeoriginClient.java)
– Mixin classes
– JSON data packs (origins, powers)
b. Relationships & Interactions
1. Gradle compiles Java sources + packages resources → slimeorigin.jar
2. Fabric Loader loads slimeorigin.jar at game startup
3. Fabric reads fabric.mod.json → invokes entry points
– Common entry (registers data pack providers, origin layers)
– Client entry (register renderers/events)
4. Mixin framework weaves mixin classes into Minecraft’s Block, LivingEntity, SlimeBlock at class-load time
5. Data loader subsystem ingests JSON origin & power definitions, merges with Origins mod
6. During gameplay, the injected mixins & power handlers respond to game events (jump, fall, damage)
c. Architectural Patterns & Principles
– Data-driven design: powers and origins defined in JSON
– Dependency injection at the bytecode level via Fabric Mixin
– Clear separation of common vs. client logic (entry points)
– Modular build via Gradle, explicit mod metadata
d. Key Technologies & Frameworks
– Java 17+ (per Gradle/Fabric defaults)
– Gradle with Fabric Loom plugin
– Fabric API (entrypoints, data loading)
– Fabric Mixin (runtime bytecode weaving)
– Origins Mod API (extension points)