# pnk2u/more-stick-variants architecture

> Architecture diagram of the GitHub repository pnk2u/more-stick-variants, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pnk2u/more-stick-variants
- Repository: https://github.com/pnk2u/more-stick-variants

## Overview

##### Project Type and Purpose
- This is a Fabric-based Minecraft mod (“More Stick Variants”) written in Java/Gradle.
- Purpose: augment Minecraft by adding wood-type variants for the Stick item, inject compatibility recipes, loot rules, villager-trade behavior, and ship built-in datapacks & resourcepacks.

##### Key Architectural Components
a. Minecraft Game Engine
b. Fabric Loader & Fabric API
c. Mixin Framework
d. Mod JAR ("More Stick Variants")
- Java code under src/main/java
- Mixin definitions (mixins.json, access widener)
- Entry point: MoreStickVariants.java
- Trade customizer: MstvVillagerTrades + AbstractVillagerMixin
e. Resources packaged in the JAR
- assets/mstv-base: item models, textures, language files
- data/mstv-base, data/lolmgv, etc.: datapacks (recipes, advancements, loot tables, tags)
- resourcepacks/mstv-leaves-loot-fix: optional resourcepack
f. Gradle Build & Loom
- build.gradle, latest-loom.gradle handle compilation, remapping, publishing
g. CI/CD Workflow
- .github/workflows/publish.yml for automated publishing to CurseForge/Modrinth

##### Runtime Interaction Flow
1. User launches Minecraft → Fabric Loader initializes
2. Fabric API loads mod JARs and registers entry points
3. Mixin Framework reads mixin JSON → applies bytecode injections on Minecraft classes (e.g., AbstractVillager)
4. Mod entry initializes: registers custom item definitions & data pack provider
5. Data Pack Manager loads built-in datapacks from data/… in the JAR
6. Resource Manager loads assets (item models, textures, languages)
7. During game events:
- Loot table resolution uses mod-supplied loot JSON
- Recipe book reads mod’s recipes
- Villager trade logic calls into injected code in MstvVillagerTrades
8. Optional resourcepack (“leaves-loot-fix”) can override block loot tables at runtime

##### Architectural Patterns & Principles
- Inversion of Control via Fabric’s entrypoint annotations
- Mixin-based Aspect Injection for extending vanilla behavior without forks
- Data-Driven Design: almost all new items, recipes, loot tables, advancements are JSON-driven datapacks
- Separation of Concerns: Java code focuses on runtime hooks/trade logic; JSON in /data and /assets for content
- Build Automation: Gradle + Fabric Loom for remapping and packaging

A. Initialization Phase
- Minecraft Engine loads Fabric Loader → loads Fabric API & Mod JAR
- Mixin subsystem applies patches to vanilla classes
B. Registration Phase
- Mod registers built-in datapacks & resources
- Data Pack Manager ingests JSON definitions
C. Runtime Hooks
- Loot Table & Recipe resolution (data-driven)
- Villager trade customization via mixin hook
D. Build & CI Pipeline (for context)
- Gradle build → Loom remap → JAR creation → GitHub Actions → Publishing

— End of Explanation —

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Initialization Phase
    subgraph "Initialization Phase"
        direction TB
        Engine["Minecraft Engine"]:::engine
        Loader["Fabric Loader"]:::loader
        API["Fabric API"]:::loader
        MixinFW["Mixin Framework"]:::loader
        Engine -->|"initializes"| Loader
        Loader -->|"loads mods"| API
        API -->|"registers entrypoints"| ModEntrypoint
        Loader -->|"reads mixin JSON"| MixinFW
    end

    %% Mod Code Components
    subgraph "Mod Code (Green)" 
        direction TB
        ModEntrypoint["MoreStickVariants (Entrypoint)"]:::mod
        ItemClass["MoreStickVariantItem"]:::mod
        ItemRegistry["MoreStickVariantItems"]:::mod
        TradeLogic["MstvVillagerTrades"]:::mod
        VillagerMixin["AbstractVillagerMixin"]:::mod
        ModEntrypoint -->|"registers items"| ItemRegistry
        ItemRegistry -->|"creates items"| ItemClass
        ModEntrypoint -->|"initializes trades"| TradeLogic
        MixinFW -->|"injects into"| VillagerMixin
        TradeLogic -->|"calls mixin hooks"| VillagerMixin
    end

    %% Registration Phase
    subgraph "Registration Phase"
        direction TB
        DataPackMgr["Data Pack Manager"]:::data
        ResourceMgr["Resource Manager"]:::data
        ModEntrypoint -->|"provides datapacks"| DataPackMgr
        ModEntrypoint -->|"provides assets"| ResourceMgr
        DataPackMgr -->|"loads JSON datapacks"| Datapacks
        ResourceMgr -->|"loads assets"| Assets
    end

    %% Datapacks & Assets
    subgraph "Datapacks & Resources (Orange)"
        direction TB
        Datapacks["Built-in Datapacks"]:::data
        Assets["Assets & Resourcepacks"]:::data
        OptionalRP["Optional Resourcepack"]:::data
    end

    %% Runtime Hooks
    subgraph "Runtime Hooks"
        direction TB
        Loot["Loot Table Resolution"]:::data
        Recipe["Recipe Processing"]:::data
        TradeHook["Villager Trade Logic"]:::data
        Datapacks -->|"drives"| Loot
        Datapacks -->|"drives"| Recipe
        VillagerMixin -->|"hooks into"| TradeHook
    end

    %% Build & CI Pipeline
    subgraph "Build & CI Pipeline"
        direction TB
        Gradle["Gradle Build"]:::build
        Loom["Loom Remap"]:::build
        Jar["Jar Creation"]:::build
        CI["GitHub Actions"]:::build
        Publish["Publish to CurseForge/Modrinth"]:::build
        Gradle --> Loom
        Loom --> Jar
        Jar --> CI
        CI --> Publish
    end

    %% Connections
    Engine --> Loader
    Datapacks --> OptionalRP

    %% Click Events
    click ModEntrypoint "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/java/de/pnku/mstv_base/MoreStickVariants.java"
    click ItemClass "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/java/de/pnku/mstv_base/item/MoreStickVariantItem.java"
    click ItemRegistry "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/java/de/pnku/mstv_base/item/MoreStickVariantItems.java"
    click TradeLogic "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/java/de/pnku/mstv_base/trade/MstvVillagerTrades.java"
    click VillagerMixin "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/java/de/pnku/mstv_base/trade/mixin/AbstractVillagerMixin.java"
    click MixinFW "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/resources/mstv-base.trade.mixins.json"
    click MixinFW "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/resources/mstv-base.accesswidener"
    click Assets "https://github.com/pnk2u/more-stick-variants/tree/1.21(.1)/src/main/resources/assets/mstv-base"
    click Datapacks "https://github.com/pnk2u/more-stick-variants/tree/1.21(.1)/src/main/resources/data/mstv-base"
    click Datapacks "https://github.com/pnk2u/more-stick-variants/tree/1.21(.1)/src/main/resources/data/minecraft"
    click Datapacks "https://github.com/pnk2u/more-stick-variants/tree/1.21(.1)/src/main/resources/data/lolmgv"
    click Datapacks "https://github.com/pnk2u/more-stick-variants/tree/1.21(.1)/src/main/resources/data/nemos-campfires"
    click Datapacks "https://github.com/pnk2u/more-stick-variants/tree/1.21(.1)/src/main/resources/data/quad"
    click OptionalRP "https://github.com/pnk2u/more-stick-variants/tree/1.21(.1)/src/main/resources/resourcepacks/mstv-leaves-loot-fix"
    click OptionalRP "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/resources/resourcepacks/mstv-leaves-loot-fix/pack.mcmeta"
    click CI "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/.github/workflows/publish.yml"
    click Gradle "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/build.gradle"
    click Loom "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/latest-loom.gradle"
    click CI "https://github.com/pnk2u/more-stick-variants/blob/1.21(.1)/src/main/resources/fabric.mod.json"

    %% Styles
    classDef engine fill:#bbbbbb,stroke:#333,stroke-width:1px
    classDef loader fill:#a0c4ff,stroke:#333,stroke-width:1px
    classDef mod fill:#caffbf,stroke:#333,stroke-width:1px
    classDef data fill:#ffd6a5,stroke:#333,stroke-width:1px
    classDef build fill:#bdb2ff,stroke:#333,stroke-width:1px
```
