# neoforgemdks/mdk-26.1.2-moddevgradle architecture

> Architecture diagram of the GitHub repository neoforgemdks/mdk-26.1.2-moddevgradle, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-05-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/neoforgemdks/mdk-26.1.2-moddevgradle
- Repository: https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle

## Overview

1. This repository is a NeoForge Minecraft mod template, not a finished feature mod. Its architecture is mostly the standard mod bootstrap shape: build tooling, mod metadata, a common mod entrypoint, a client-only entrypoint, and resource files.

2. The build layer is Gradle-based. `build.gradle`, `settings.gradle`, `gradle.properties`, and the Gradle wrapper define how the mod is compiled, packaged, and run in a local development environment. The `.github/workflows/build.yml` file indicates CI automation for building the mod artifact.

3. The runtime boundary is the NeoForge mod loader plus the Minecraft client/server runtime. `src/main/templates/META-INF/neoforge.mods.toml` is the mod descriptor template that NeoForge uses to discover the mod, declare its ID, and wire lifecycle metadata.

4. The main Java package is `com.example.examplemod`, which is the mod namespace. `ExampleMod.java` is the primary mod entrypoint for shared logic that runs in the mod lifecycle. In a diagram, this is the central node that the loader invokes first.

5. `ExampleModClient.java` is the client-side entrypoint. It represents the client-only boundary where rendering, input, or other client-specific registration would live. This separation matters because it prevents client code from loading on dedicated servers.

6. `Config.java` is the configuration subsystem. Even though the template likely has minimal implementation, it marks where mod settings and tunables are defined and loaded. Architecturally, this is the state/config boundary between user-editable values and mod logic.

7. Resources are split by concern under `src/main/resources`. The `assets/examplemod/lang/en_us.json` file is the localization layer, providing human-readable text for the mod’s UI/messages. This is the first concrete content pipeline from code identifiers to user-facing strings.

8. `src/main/templates` is a packaging-time templating area rather than runtime content. The presence of the `META-INF/neoforge.mods.toml` template suggests the build process assembles final metadata during distribution, which is important for how the mod is identified and loaded.

9. The repository’s structure shows a clear separation between code and data: Java sources implement lifecycle hooks and configuration, while resources provide metadata and localization. There is no visible gameplay feature subsystem yet, which means the repo is primarily an architectural starting point.

10. The external dependencies and ecosystem are material to the architecture: Java, Gradle, and NeoForge define compilation, loading, and mod lifecycle behavior. The README also points to NeoForged documentation and Mojang mapping names, which affect how source code is written and understood.

11. For an architecture diagram, the main flow is: Gradle builds the mod, NeoForge reads the mod metadata, the mod loader invokes `ExampleMod` on startup, client-specific setup is delegated to `ExampleModClient`, and resources such as language files are consumed by Minecraft at runtime.

12. Overall, this is a minimal mod scaffold with three important boundaries: loader/build-time metadata, shared mod logic, and client-only logic. Everything else in the repo supports those boundaries rather than introducing separate business subsystems.

Main entry points: [`build.gradle`](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/build.gradle) (Gradle build), [`src/main/java/com/example/examplemod/ExampleMod.java`](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/java/com/example/examplemod/ExampleMod.java) (ExampleMod), [`.github/workflows/build.yml`](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/.github/workflows/build.yml) (CI workflow), [`README.md`](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/README.md) (README)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_build["Build & CI"]
  node_gradle_build["Gradle build<br/>build script<br/>[build.gradle]"]
  node_gradle_settings["Settings<br/>build config<br/>[settings.gradle]"]
  node_gradle_props["Properties<br/>build config<br/>[gradle.properties]"]
  node_gradle_wrapper["Wrapper<br/>build runtime"]
  node_github_ci["CI workflow<br/>automation<br/>[build.yml]"]
  node_repo_readme["README<br/>project docs<br/>[README.md]"]
end

subgraph group_runtime["Mod Runtime"]
  node_neo_loader(("NeoForge<br/>mod loader"))
  node_mc_runtime(("Minecraft runtime<br/>game runtime"))
  node_example_mod["ExampleMod<br/>common entrypoint<br/>[ExampleMod.java]"]
  node_client_mod["Client entry"]
  node_config["Config<br/>[Config.java]"]
end

subgraph group_resources["Resources"]
  node_mod_meta["Mod metadata<br/>descriptor template<br/>[neoforge.mods.toml]"]
  node_assets_root["Assets<br/>resource root"]
  node_lang["Language<br/>localization<br/>[en_us.json]"]
  node_mod_namespace{{"Mod namespace<br/>resource namespace"}}
end

node_gradle_settings -->|"configures"| node_gradle_build
node_gradle_props -->|"tunes"| node_gradle_build
node_gradle_wrapper -->|"pins"| node_gradle_build
node_github_ci -->|"uses"| node_gradle_wrapper
node_github_ci -->|"runs"| node_gradle_build
node_gradle_build -->|"packages"| node_mod_meta
node_gradle_build -->|"packages"| node_assets_root
node_neo_loader -->|"discovers"| node_mod_meta
node_mc_runtime -->|"hosts"| node_neo_loader
node_neo_loader -->|"invokes"| node_example_mod
node_neo_loader -->|"invokes"| node_client_mod
node_example_mod -->|"reads"| node_config
node_client_mod -->|"reads"| node_config
node_assets_root -->|"namespaces"| node_mod_namespace
node_lang -->|"belongs to"| node_mod_namespace
node_example_mod -->|"uses"| node_mod_namespace
node_repo_readme -->|"documents"| node_gradle_build
node_repo_readme -->|"documents"| node_neo_loader

click node_gradle_build "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/build.gradle"
click node_gradle_settings "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/settings.gradle"
click node_gradle_props "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/gradle.properties"
click node_gradle_wrapper "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/gradle/wrapper/gradle-wrapper.properties"
click node_github_ci "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/.github/workflows/build.yml"
click node_mod_meta "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/templates/META-INF/neoforge.mods.toml"
click node_example_mod "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/java/com/example/examplemod/ExampleMod.java"
click node_client_mod "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/java/com/example/examplemod/ExampleModClient.java"
click node_config "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/java/com/example/examplemod/Config.java"
click node_assets_root "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/tree/main/src/main/resources/assets/examplemod"
click node_lang "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/resources/assets/examplemod/lang/en_us.json"
click node_repo_readme "https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/README.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_gradle_build,node_gradle_settings,node_gradle_props,node_gradle_wrapper,node_github_ci,node_repo_readme toneBlue
class node_neo_loader,node_mc_runtime,node_example_mod,node_client_mod,node_config toneAmber
class node_mod_meta,node_assets_root,node_lang,node_mod_namespace toneMint
```

## Components

### Build & CI

Gradle-based build, wrapper, and CI automation.

- [Gradle build](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/build.gradle): build script · Defines compilation, packaging, and run tasks. · `build.gradle`
- [Settings](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/settings.gradle): build config · Names and includes the Gradle project. · `settings.gradle`
- [Properties](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/gradle.properties): build config · Shared Gradle and mod development settings. · `gradle.properties`
- [Wrapper](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/gradle/wrapper/gradle-wrapper.properties): build runtime · Pinned Gradle distribution used for builds. · `gradle/wrapper/gradle-wrapper.properties`
- [CI workflow](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/.github/workflows/build.yml): automation · Builds the mod artifact in GitHub Actions. · `.github/workflows/build.yml`
- [README](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/README.md): project docs · Explains the template, dependencies, and usage. · `README.md`

### Mod Runtime

NeoForge loader boundary and Java entrypoints.

- **NeoForge**: mod loader · Loads the mod and drives lifecycle events.
- **Minecraft runtime**: game runtime · Client/server environment hosting the mod.
- [ExampleMod](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/java/com/example/examplemod/ExampleMod.java): common entrypoint · Primary shared mod lifecycle entrypoint. · `src/main/java/com/example/examplemod/ExampleMod.java`
- [Client entry](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/java/com/example/examplemod/ExampleModClient.java): client entrypoint · Client-only registration and setup boundary. · `src/main/java/com/example/examplemod/ExampleModClient.java`
- [Config](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/java/com/example/examplemod/Config.java): configuration · Defines and loads mod tunables and settings. · `src/main/java/com/example/examplemod/Config.java`

### Resources

Packaged metadata and localization resources.

- [Mod metadata](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/templates/META-INF/neoforge.mods.toml): descriptor template · Template metadata used for mod discovery and packaging. · `src/main/templates/META-INF/neoforge.mods.toml`
- [Assets](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/tree/main/src/main/resources/assets/examplemod): resource root · Packaged game assets under the mod namespace. · `src/main/resources/assets/examplemod`
- [Language](https://github.com/neoforgemdks/mdk-26.1.2-moddevgradle/blob/main/src/main/resources/assets/examplemod/lang/en_us.json): localization · Human-readable strings for UI and messages. · `src/main/resources/assets/examplemod/lang/en_us.json`
- **Mod namespace**: resource namespace · Shared resource identifier used by code and assets.

## Connections

- Settings → Gradle build: configures · Project settings feed the build definition.
- Properties → Gradle build: tunes · Shared properties control Gradle and mod parameters.
- Wrapper → Gradle build: pins · Wrapper selects the Gradle version used locally and in CI.
- CI workflow → Wrapper: uses · CI relies on the wrapper to build consistently.
- CI workflow → Gradle build: runs · Workflow executes the project build.
- Gradle build → Mod metadata: packages · Build assembles the mod metadata template into the artifact.
- Gradle build → Assets: packages · Build includes game assets in the mod jar.
- NeoForge → Mod metadata: discovers · NeoForge reads metadata to identify the mod.
- Minecraft runtime → NeoForge: hosts · Minecraft provides the runtime environment for the loader.
- NeoForge → ExampleMod: invokes · Loader calls the shared mod entrypoint during lifecycle startup.
- NeoForge → Client entry: invokes · Loader initializes the client entrypoint on the client side.
- ExampleMod → Config: reads · Shared mod logic consumes configuration state.
- Client entry → Config: reads · Client-specific setup may also use configuration.
- Assets → Mod namespace: namespaces · Asset files live under the mod namespace.
- Language → Mod namespace: belongs to · Localization file is part of the mod's asset namespace.
- ExampleMod → Mod namespace: uses · Java package and identifiers align with the mod namespace.
- README → Gradle build: documents · README explains the build and development workflow.
- README → NeoForge: documents · README describes the NeoForge runtime and loader conventions.
