# gmitch215/mobchip architecture

> Architecture diagram of the GitHub repository gmitch215/mobchip, 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/gmitch215/mobchip
- Repository: https://github.com/gmitch215/mobchip

## Overview

##### Project type and purpose
- This is an open-source, multi-module Java/Kotlin library (“MobChip”) for Minecraft (versions 1.13+).
- Purpose: Provide a unified Entity AI & Bosses API by abstracting Minecraft’s native AI, offering version compatibility via reflection/abstraction layers, and integrating with Bukkit as a plugin module.

##### File structure
- Top-level modules (Gradle projects):
- abstraction – Defines interfaces, utility classes (ChipUtil, CreatureBehavior, NBTSection, etc.)
- base – Core AI engine: brains, bodies, AIs, behaviors, navigation, memories, schedules; uses abstraction interfaces
- bukkit – Platform integration: BukkitAI, event listeners, plugin entry point, ties core engine to server
- nms – Subfolders for each Minecraft server version (1_13_R1 … 1_20_R4): version-specific implementations of abstraction interfaces
- Build & CI:
- build.gradle.kts in root and each module, settings.gradle.kts, Gradle wrapper, GitHub Actions workflow (build.yml)
- Documentation: JavaDocs under bukkit/src/main/javadoc, README, CONTRIBUTING, LICENSE

##### README for additional insights
- Emphasizes abstraction for compatibility, ease of use, reflection, version checker, open-source.
- Installation via Maven/Gradle “mobchip-bukkit” artifact, pointing to CodeMC Maven repo.

a. Main components
- Abstraction Layer (interfaces, utilities)
- Core Engine (base module: AI controllers, behaviors, schedules, NBT, combat)
- Version Adapters (nms modules: one submodule per supported server version)
- Platform Adapter (bukkit module: plugin bootstrap, event hooks, API surface for plugin authors)
- Build & CI (Gradle, GitHub Actions)
- External Repositories (CodeMC Maven, GitHub)

b. Relationships and interactions
- base and nms modules implement and consume abstraction interfaces
- At runtime, bukkit module instantiates BaseEngine, invokes VersionChecker to load appropriate nms adapter via reflection
- Plugin code (user) calls Bukkit API facades, which delegate to BaseEngine → abstraction → version adapter
- CI pipeline executes Gradle builds, tests across modules, publishes artifacts to Maven

c. Architectural patterns & principles
- Layered architecture: Abstraction → Core → Adapters → Platform
- Dependency Inversion: core depends on interfaces; adapters provide concrete implementations
- Plugin architecture: bukkit module as plugin entry point
- Reflection-based version loading for backward/forward compatibility

d. Key technologies
- Java & Kotlin (Kotlin DSL in some modules)
- Gradle Kotlin DSL for build scripts
- Bukkit API for server integration
- Reflection and abstraction for version independence

##### Key details to capture
- Multi-module Gradle structure
- Runtime version resolution mechanism
- Clear separation of concerns: interfaces vs. engine vs. adapters vs. integration
- Build/test/publish workflow

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Abstraction Layer"
        Abstraction["Interfaces & Utilities"]:::interfaces
    end

    subgraph "Core Engine (base)"
        Core["AI & Behaviors"]:::core
    end

    subgraph "Version Adapters (nms modules)"
        Adapter["NMS Implementations"]:::adapter
    end

    subgraph "Platform Adapter (bukkit plugin)"
        Platform["Bukkit Plugin"]:::adapter
        Events["Event Listeners"]:::adapter
    end

    subgraph "Build & CI"
        BuildScripts["Gradle Scripts"]:::tool
        Settings["Settings Script"]:::tool
        GradleDir["Gradle Wrapper"]:::tool
        CI["GitHub Actions"]:::tool
    end

    subgraph "Documentation & Guidelines"
        JavaDocs["JavaDocs"]:::tool
        ProjectDocs["README & CONTRIBUTING & LICENSE"]:::tool
    end

    Maven["Maven Repo"]:::external

    Core -->|uses interfaces| Abstraction
    Adapter -->|implements interfaces| Abstraction
    Platform -->|loads at runtime| Adapter
    Platform -->|calls core API| Core
    CI --> BuildScripts
    CI --> Settings
    CI --> GradleDir
    BuildScripts -->|builds modules| Abstraction
    BuildScripts -->|builds modules| Core
    BuildScripts -->|builds modules| Adapter
    BuildScripts -->|builds modules| Platform
    CI -->|publishes artifacts| Maven

    click Abstraction "https://github.com/gmitch215/mobchip/tree/master/abstraction/src/main/java/me/gamercoder215/mobchip/abstraction"
    click Core "https://github.com/gmitch215/mobchip/tree/master/base/src/main/java/me/gamercoder215/mobchip"
    click Platform "https://github.com/gmitch215/mobchip/tree/master/bukkit/src/main/java/me/gamercoder215/mobchip/bukkit"
    click Events "https://github.com/gmitch215/mobchip/tree/master/bukkit/src/main/java/me/gamercoder215/mobchip/bukkit/events"
    click Adapter "https://github.com/gmitch215/mobchip/tree/master/nms/1_13_R1/src/main/java/me/gamercoder215/mobchip/abstraction/v1_13_R1"
    click BuildScripts "https://github.com/gmitch215/mobchip/blob/master/build.gradle.kts"
    click Settings "https://github.com/gmitch215/mobchip/blob/master/settings.gradle.kts"
    click GradleDir "https://github.com/gmitch215/mobchip/tree/master/gradle/"
    click CI "https://github.com/gmitch215/mobchip/blob/master/.github/workflows/build.yml"
    click JavaDocs "https://github.com/gmitch215/mobchip/tree/master/bukkit/src/main/javadoc"
    click ProjectDocs "https://github.com/gmitch215/mobchip/blob/master/README.md"

    classDef interfaces fill:#bbf,stroke:#55f,color:#000
    classDef core fill:#bfb,stroke:#5b5,color:#000
    classDef adapter fill:#fbb,stroke:#f55,color:#000
    classDef tool fill:#fbf,stroke:#f5f,color:#000
    classDef external fill:#ddd,stroke:#999,color:#000
```
