DreamAPI is a modular API and runtime foundation for the Dreamin ecosystem. It targets modern Paper servers and provides reusable systems for commands, recipes, items, visual effects, world tools, localization, and service-driven architecture.
- Multi-module architecture with
api,core,plugin-base, andexample-plugin. - Service-oriented runtime with dependency-aware loading (
@DreamAutoService) and lifecycle hooks. - Rich gameplay tooling including recipes, item registry, glowing, tab list, world border, and cuboids.
- NMS visual utilities for fake entities, fake blocks, and client-side visual state.
- Localization stack based on Adventure translators and JSON language files.
- Plugin bootstrap layer via
DreamPluginwith automatic service, listener, and command wiring.
DreamAPI aims to provide a public, production-focused foundation for Paper plugin development by:
- reducing boilerplate through shared abstractions,
- standardizing service patterns across projects,
- enabling faster prototyping with reusable runtime components,
- keeping plugin internals maintainable with clear module boundaries.
DreamAPI/
api/ // Public interfaces, models, and contracts
core/ // Runtime implementations
plugin-base/ // DreamPlugin base class and bootstrap helpers
example-plugin/ // Reference plugin using DreamAPI
For plugin integration, service pages are usually the most useful entry point.
Visual & NMS
AnimationServiceGlowingServiceHologramServiceSkinServiceTabListServiceVisualServiceWorldBorderService
Gameplay & Data
CuboidServiceGameServiceItemRegistryServiceRecipeRegistryServiceRecipeCategoryRegistryServiceRecipeViewerServiceWorldService
Utility & Integration
Core/Internal Services
Full directory: docs/services/index.md
Maven
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>com.github.Dreamin-MC</groupId>
<artifactId>DreamAPI</artifactId>
<version>0.3.4</version>
</dependency>Gradle (Kotlin DSL)
repositories {
maven("https://jitpack.io")
}
dependencies {
compileOnly("com.github.Dreamin-MC:DreamAPI:0.3.4")
}Gradle (Groovy DSL)
repositories {
maven { url = "https://jitpack.io" }
}
dependencies {
compileOnly "com.github.Dreamin-MC:DreamAPI:0.3.4"
}DreamAPI is the shared technical base used by Dreamin modules and plugins.
| Project | Description |
|---|---|
| DreamAPI | Core modular API/runtime foundation |
| Status | Current Version | Target Runtime |
|---|---|---|
| Active development | v0.3.4 |
Java 25 + Paper 26.1.2.build.+ |
| Version Line | Runtime Notes |
|---|---|
v0.2.x |
Current development line |
v1.0.0 |
Planned stable line with API freeze |
DreamAPI is still evolving. Breaking changes may happen before
v1.0.0. For production servers, pin exact versions and test upgrades first.
api: public contracts and interfacescore: service implementations and runtime internalsplugin-base:DreamPluginbootstrap classexample-plugin: integration reference project
- Documentation hub:
docs/index.md - Architecture:
docs/architecture.md - Services folder guide:
docs/services/README.md - Service recipes:
docs/examples/service-recipes.md - Module docs:
- Service documentation (one page per service):
docs/services/index.md
If you are integrating DreamAPI publicly, start with:
Contributions are welcome. Before opening a pull request:
- follow the existing code style and package conventions,
- preserve backward compatibility where possible,
- add or update tests when behavior changes,
- update documentation for public-facing API changes,
- validate on the current Paper runtime line.
DreamAPI integrates with a set of known libraries, including:
Dependency scopes may differ by module (implementation vs compileOnly), see each module build file for exact runtime expectations.
This project is distributed under the GPL-3.0 license.
See LICENSE.
- Issues: GitHub Issues
- Discord: Dreamin Discord
