How napasitng/neoforg-learn works
Project Type and Purpose
• This is a template Minecraft “mod” project using the NeoForged/Forge ecosystem.
• The goal is to generate a Java-based game extension (mod) that the Minecraft client/server will load at runtime.
High-Level File Structure Analysis
• Top‐level build files and configs:
• build.gradle, gradlew(.bat), gradle/…, settings.gradle → Gradle build system
• .github/workflows/build.yml → CI build pipeline
• Source code under src/main/java/com/example/examplemod:
• ExampleMod.java → main mod entry point (lifecycle hooks, event bus registrations)
• Config.java → mod configuration class
• Resources under src/main/resources/META-INF/neoforge.mods.toml → mod metadata descriptor
Key Architectural Elements
• Developer Environment
• GitHub repository (template) → versioning & CI
• IDE (IntelliJ/Eclipse) → code editing, Gradle integration
• Build System
• Gradle wrapper → deterministic builds, dependency resolution (Minecraft libraries, mappings)
• NeoGradle plugin → launch groups for dev environment (client/server)
• CI workflow → automated build & test on push
• Runtime Environment
• Minecraft client or server
• NeoForged/Forge Mod Loader → dynamic plugin loader, event bus
• Your mod JAR → loaded via neoforge.toml descriptor
• Config subsystem → runtime mod settings
1. Developer Workstation (IDE + GitHub)
2. Gradle Build System
3. Continuous Integration Server (GitHub Actions)
4. Minecraft + NeoForged Mod Loader
5. Mod Components (ExampleMod code, Config, Resources)
6. External Dependencies (Mojang mappings, Forge libraries)
• Developer → Git push → GitHub repo → triggers → CI pipeline
• Developer/IDE ↔ Gradle wrapper → build, refresh-dependencies
• Gradle → resolves → external dependencies (Mojang mappings, Forge jars)
• Gradle → compiles sources & packages → mod JAR + neoforge.mods.toml
• Minecraft client/server + NeoForged → loads → mod JAR at runtime
• Mod’s ExampleMod ↔ NeoForged event bus → registers game hooks
• Config ↔ mod’s runtime → reads/writes user settings file
c. Architectural Patterns and Principles
• Plugin architecture (mod loader dynamically discovers and loads your JAR)
• Separation of concerns: build configuration vs. source code vs. runtime metadata
• Convention over configuration: neoforge.toml in META-INF drives discovery
• Event‐driven design: ExampleMod listens on Forge’s event bus
d. Technologies & Frameworks
• Java 17+ (as specified by Gradle properties)
• NeoForged/Forge Mod Loader API
• Gradle & NeoGradle plugin
• GitHub Actions for CI