# linkachugaming/stackable architecture

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

- Interactive diagram: https://gitdiagram.com/linkachugaming/stackable
- Repository: https://github.com/linkachugaming/stackable

## Overview

##### Main Components
- Mod Entry Points: Represent the main classes that serve as the mod’s initialization points. For example, in src/main/java/com/lonkachu/ you have StackableMod.java (likely the central mod class) and Config.java plus configLoader.java which handle configuration.
- Client Side Logic: Located in src/client (e.g., ExampleModClient.java). This component deals with client-specific functionality.
- Mixin Layers: Split between client-side mixins (e.g., DrawContextFixin.java in src/client/java/com/lonkachu/mixin/client) and main mixins (e.g., BundleItemMixin.java, DataComponentTypesFixin.java, InventoryStackMixin.java, ItemEntityMixin.java in src/main/java/com/lonkachu/mixin). These mixins are critical as they intervene in Minecraft’s classes to support the new stack sizes.
- Resources & Configuration: This includes assets in src/main/resources/assets, and the fabric.mod.json file that defines mod metadata. The mixin configuration files (fabric.mod.json, stackable.mixins.json, and stackable.client.mixins.json) are key to wiring up the mixin transformations.
- Build and Deployment Infrastructure: Note the Gradle files (build.gradle, settings.gradle, etc.) and the GitHub workflows (.github/workflows/build.yml). They manage builds, dependencies, and CI pipelines.

##### Relationships and Interactions
- The Mod Loader (Fabric) acts as the environment in which the mod is injected into Minecraft. Represent it as an external dependency.
- The main mod class (StackableMod.java) registers mod features during initialization. It interacts with configuration classes to adjust behavior dynamically.
- Mixins are “advice” layers that intercept or modify Minecraft’s native code at runtime. They are triggered when Minecraft classes are loaded, hence link directly to Minecraft’s code (which can be depicted as an external “Minecraft Engine” component).
- The client and main modules may have overlapping roles: while the main code handles general logic, the client module updates client-specific elements.
- The resources (assets and configuration files) tie into both mod metadata (fabric.mod.json) and mixin configurations, instructing the mod loader on how to apply mixins.

##### Architectural Patterns and Design Principles
- Configuration and Dependency Injection: Highlight that configuration files (fabric.mod.json, mixin JSON files) determine entry points and behavior adjustments.
- CI/CD Pipeline: Include a side component that covers build automation (Gradle scripts and GitHub workflows).

##### Essential Detail
Architectural element is detailed—instead of a generic “Backend” block, split the system into all the components identified: mod initializer, configuration loader, mixin transformers for client and main operations, and indicate the external Minecraft environment. This level of granularity is important given the experimental nature of mod development and mixin injection.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Components
    external1["Fabric Mod Loader"]:::external
    external2["Minecraft Engine (Minecraft 1.20.5)"]:::external

    %% Mod Entry Points
    subgraph "Mod Entry Points"
        modInit["Mod Initialization (StackableMod)"]:::entry
        config1["Config (Config.java)"]:::entry
        config2["Config Loader (configLoader.java)"]:::entry
    end

    %% Client Module
    subgraph "Client Module"
        clientLogic["Client Logic (ExampleModClient.java)"]:::client
    end

    %% Mixins
    subgraph "Mixins"
        subgraph "Main Mixins"
            bundle["BundleItemMixin"]:::mixin
            data["DataComponentTypesFixin"]:::mixin
            inventory["InventoryStackMixin"]:::mixin
            item["ItemEntityMixin"]:::mixin
        end
        subgraph "Client Mixins"
            draw["DrawContextFixin"]:::mixin
        end
    end

    %% Resources & Configuration
    subgraph "Resources & Configuration"
        modMetadata["Mod Metadata (fabric.mod.json)"]:::resource
        mixinMain["Mixin Config (stackable.mixins.json)"]:::resource
        mixinClient["Client Mixin Config (stackable.client mixins.json)"]:::resource
        assets["Assets (stackable)"]:::resource
    end

    %% Build/CI Infrastructure
    subgraph "Build/CI Infrastructure"
        gradle["Gradle Scripts (build.gradle,settings.gradle,gradle.properties)"]:::build
        github["GitHub Workflow (build.yml)"]:::build
        wrapper["Gradle Wrapper (gradlew,gradlew.bat,gradle/wrapper)"]:::build
    end

    %% Connections
    external1 -->|"injects"| modInit
    modInit -->|"reads"| config1
    modInit -->|"reads"| config2
    modInit -->|"initializes"| clientLogic
    modInit -->|"loads"| bundle
    modInit -->|"loads"| draw

    modMetadata -->|"configures"| modInit
    mixinMain -->|"configuresMixins"| modInit
    mixinClient -->|"configuresClientMixins"| modInit

    gradle -->|"builds"| modInit
    github -->|"builds"| modInit
    wrapper -->|"builds"| modInit

    bundle -->|"injects"| external2
    data -->|"injects"| external2
    inventory -->|"injects"| external2
    item -->|"injects"| external2
    draw -->|"injects"| external2

    %% Styles
    classDef entry fill:#FFDAB9,stroke:#333,stroke-width:2px;
    classDef client fill:#B0E0E6,stroke:#333,stroke-width:2px;
    classDef mixin fill:#98FB98,stroke:#333,stroke-width:2px;
    classDef resource fill:#D8BFD8,stroke:#333,stroke-width:2px;
    classDef build fill:#FFFACD,stroke:#333,stroke-width:2px;
    classDef external fill:#E0E0E0,stroke:#333,stroke-width:2px;

    %% Click Events
    click modInit "https://github.com/linkachugaming/stackable/blob/origin/src/main/java/com/lonkachu/StackableMod.java"
    click config1 "https://github.com/linkachugaming/stackable/blob/origin/src/main/java/com/lonkachu/Config.java"
    click config2 "https://github.com/linkachugaming/stackable/blob/origin/src/main/java/com/lonkachu/configLoader.java"
    click clientLogic "https://github.com/linkachugaming/stackable/blob/origin/src/client/java/com/lonkachu/ExampleModClient.java"
    click bundle "https://github.com/linkachugaming/stackable/blob/origin/src/main/java/com/lonkachu/mixin/BundleItemMixin.java"
    click data "https://github.com/linkachugaming/stackable/blob/origin/src/main/java/com/lonkachu/mixin/DataComponentTypesFixin.java"
    click inventory "https://github.com/linkachugaming/stackable/blob/origin/src/main/java/com/lonkachu/mixin/InventoryStackMixin.java"
    click item "https://github.com/linkachugaming/stackable/blob/origin/src/main/java/com/lonkachu/mixin/ItemEntityMixin.java"
    click draw "https://github.com/linkachugaming/stackable/blob/origin/src/client/java/com/lonkachu/mixin/client/DrawContextFixin.java"
    click modMetadata "https://github.com/linkachugaming/stackable/blob/origin/src/main/resources/fabric.mod.json"
    click mixinMain "https://github.com/linkachugaming/stackable/blob/origin/src/main/resources/stackable.mixins.json"
    click mixinClient "https://github.com/linkachugaming/stackable/blob/origin/src/client/resources/stackable.client.mixins.json"
    click assets "https://github.com/linkachugaming/stackable/tree/origin/src/main/resources/assets/stackable"
    click gradle "https://github.com/linkachugaming/stackable/blob/origin/build.gradle"
    click github "https://github.com/linkachugaming/stackable/blob/origin/.github/workflows/build.yml"
    click wrapper "https://github.com/linkachugaming/stackable/tree/origin/gradlew"
```
