FoundryEngine

A NeoForge mod that turns Minecraft into a game engine. Mod ID foundryengine, package de.luckymcdev.foundryengine.

Features

• In-game editor - ImGui-based editor with 18+ dockable panels for scene management, blueprints, cutscenes, areas, waypoints, code editing, file browsing, and more
• Bundle system - Self-contained mod packaging (scripts, assets, data packs, blueprints). No Java compilation needed.
• Groovy scripting - Full Groovy 5 runtime for bundle logic. Register items, blocks, recipes, sounds, and particles from scripts.
• Blueprint visual scripting - Node-based graph editor with execution flow, typed pins, and built-in event nodes
• Cutscene system - Bezier spline camera paths with per-node rotations, screen effects, server commands, and a full timeline editor
• Instanced worlds - Create temporary or persistent runtime dimensions with configurable chunk generators, clocks, and game rules
• Game stages - Progression framework gating items, mobs, dimensions, loot tables, and recipes behind player-specific stages
• Custom rendering - Mesh renderer with 8 render pipelines, OBJ model support, post-processing effects, and 20 shaders
• Areas and waypoints - Spatial zone triggers with modular behavior system and persistent in-world markers
• Custom particles - Keyframe-driven particle system with sequenced color, scale, velocity, position, and rotation
• Post-processing - Priority-based shader effect system with GLSL pipeline support, fade transitions, and built-in effects
• Game sessions - Managed lifecycle system for game modes with persistent NBT data
• Event system - 84 events across 16 event classes for blocks, items, players, entities, levels, and more
• Data generation - Built-in bundle data generator for automated resource creation

Quick start

./gradlew.bat build                # full build
./gradlew.bat preCommit            # check + runData + build (commit pipeline)
./gradlew.bat runClient            # launch MC client
npm run docs:dev                   # VitePress docs (--host for network access)

Documentation

Full documentation is available at docs/ or run npm run docs:dev to serve locally.

• Installation Guide
• Getting Started
• Bundle System
• Builders API
• Events Reference
• Examples
• Commands Reference

Architecture

FoundryEngine/
├── common/            Shared logic (cutscenes, easing, network, world, blueprints, bundles, events, builders)
├── client/            Client-only code (ImGui editor, rendering, particles, post-processing)
├── server/            Server-only code (commands, dynamic packs)
├── interfaces/        Mixin accessor interfaces for runtime property modification
├── mixin/             39 mixin classes for rendering, world, input, UI, and more
├── config/            NeoForge config classes
├── src/
│   ├── main/java/     Java sources
│   └── generated/     Data generator output
└── docs/              VitePress documentation site

Key paths

Path	Purpose
runs/client, runs/server	Minecraft run directories
ExampleBundles/	Groovy scripting bundles for testing
FoundryEngine/bundles/ (in-game)	Bundle/script install location
docs/	VitePress documentation site
repo/	Local Maven publish target