# jack-sibley/slimeorigin architecture

> Architecture diagram of the GitHub repository jack-sibley/slimeorigin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jack-sibley/slimeorigin
- Repository: https://github.com/jack-sibley/slimeorigin

## Overview

##### 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)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build Layer
    subgraph "Build Layer"
        direction TB
        BuildGradle["build.gradle"]:::build
        SettingsGradle["settings.gradle"]:::build
        Gradlew["gradlew / gradlew.bat"]:::build
        WrapperJar["gradle/wrapper/gradle-wrapper.jar"]:::build
        WrapperProps["gradle/wrapper/gradle-wrapper.properties"]:::build
    end

    %% Mod Jar Packaging
    BuildGradle -->|compiles & packages| ModJar["slimeorigin.jar"]:::mod

    %% Mod Jar Contents
    subgraph "Mod Jar Contents" 
        direction TB
        FabricModJSON["fabric.mod.json"]:::mod
        subgraph "Entrypoints" 
            direction TB
            CommonEntry["Slimeorigin.java"]:::mod
            ClientEntry["SlimeoriginClient.java"]:::mod
        end
        MixinConfig["slimeorigin.mixins.json"]:::mod
        subgraph "Mixin Classes"
            direction TB
            MixinBlock["MixinBlock.java"]:::mod
            MixinLivingEntity["MixinLivingEntity.java"]:::mod
            MixinSlimeBlock["MixinSlimeBlock.java"]:::mod
        end
        subgraph "Data Packs"
            direction TB
            OriginLayer["origin_layers/origin.json"]:::data
            subgraph "Origin Definitions"
                direction TB
                SlimeOriginDef["slimecican.json"]:::data
            end
            subgraph "Power Definitions"
                direction TB
                JumpPower["better_jump.json"]:::data
                JumpDummy["better_jump_dummy.json"]:::data
                Bouncy["bouncy.json"]:::data
                Fragmentation["fragmentation.json"]:::data
                Melting["melting.json"]:::data
                NoFall["no_fall_damage_dummy.json"]:::data
                SlimeSkin["slime_skin.json"]:::data
            end
            Assets["assets/slimeorigin"]:::data
        end
    end

    %% Runtime Layers
    ModJar -->|loaded by| FabricLoader["Fabric Mod Loader & API"]:::loader
    FabricLoader -->|reads metadata| FabricModJSON
    FabricLoader -->|invokes common| CommonEntry
    FabricLoader -->|invokes client| ClientEntry
    FabricLoader -->|initializes mixin| MixinEngine["Fabric Mixin Framework"]:::runtime

    %% Mixin weaving into game
    MixinEngine -->|weaves| MixinBlock
    MixinEngine -->|weaves| MixinLivingEntity
    MixinEngine -->|weaves| MixinSlimeBlock
    MixinEngine -->|applies| MinecraftEngine["Minecraft Game Engine"]:::engine

    %% Data loading and Origins API
    FabricLoader -->|triggers data loader| DataLoader["JSON Data Loader"]:::loader
    DataLoader --> OriginLayer
    DataLoader --> SlimeOriginDef
    DataLoader --> JumpPower
    DataLoader --> JumpDummy
    DataLoader --> Bouncy
    DataLoader --> Fragmentation
    DataLoader --> Melting
    DataLoader --> NoFall
    DataLoader --> SlimeSkin
    DataLoader -->|merges with| OriginsAPI["Origins Mod API"]:::runtime
    OriginsAPI -->|extends| MinecraftEngine

    %% Gameplay
    MinecraftEngine -->|run game with injected behavior & powers| Gameplay["Gameplay Events"]:::engine

    %% Click Events
    click BuildGradle "https://github.com/jack-sibley/slimeorigin/blob/master/build.gradle"
    click SettingsGradle "https://github.com/jack-sibley/slimeorigin/blob/master/settings.gradle"
    click Gradlew "https://github.com/jack-sibley/slimeorigin/tree/master/gradlew"
    click WrapperJar "https://github.com/jack-sibley/slimeorigin/blob/master/gradle/wrapper/gradle-wrapper.jar"
    click WrapperProps "https://github.com/jack-sibley/slimeorigin/blob/master/gradle/wrapper/gradle-wrapper.properties"
    click FabricModJSON "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/fabric.mod.json"
    click CommonEntry "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/java/dev/jacksibley/slimeorigin/Slimeorigin.java"
    click ClientEntry "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/java/dev/jacksibley/slimeorigin/client/SlimeoriginClient.java"
    click MixinConfig "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/slimeorigin.mixins.json"
    click MixinBlock "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/java/dev/jacksibley/slimeorigin/mixin/MixinBlock.java"
    click MixinLivingEntity "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/java/dev/jacksibley/slimeorigin/mixin/MixinLivingEntity.java"
    click MixinSlimeBlock "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/java/dev/jacksibley/slimeorigin/mixin/MixinSlimeBlock.java"
    click OriginLayer "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/origins/origin_layers/origin.json"
    click SlimeOriginDef "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/origins/slimecican.json"
    click JumpPower "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/powers/better_jump.json"
    click JumpDummy "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/powers/better_jump_dummy.json"
    click Bouncy "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/powers/bouncy.json"
    click Fragmentation "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/powers/fragmentation.json"
    click Melting "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/powers/melting.json"
    click NoFall "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/powers/no_fall_damage_dummy.json"
    click SlimeSkin "https://github.com/jack-sibley/slimeorigin/blob/master/src/main/resources/data/slimeorigin/powers/slime_skin.json"
    click Assets "https://github.com/jack-sibley/slimeorigin/tree/master/src/main/resources/assets/slimeorigin"

    %% Styles
    classDef build fill:#f9f,stroke:#333,stroke-width:1px
    classDef mod fill:#bbf,stroke:#333,stroke-width:1px
    classDef loader fill:#ff9,stroke:#333,stroke-width:1px
    classDef runtime fill:#9f9,stroke:#333,stroke-width:1px
    classDef data fill:#f99,stroke:#333,stroke-width:1px
    classDef engine fill:#99f,stroke:#333,stroke-width:1px
```
