Repository navigation
Home
diegonoches edited this page Nov 7, 2026
·
4 revisions
These pages mirror the versioned guides in the 3.0.0 branch's docs directory.
Building a plugin with Codex? Install the public $winter-development skill for Winter 3 Paper and Velocity projects.
- Getting started: dependencies, boot class, and a first component.
-
Configuration: compile-time
winter.properties, diagnostics, and YAML files. - Architecture: generated metadata and the runtime pipeline.
- Components: discovery, stereotypes, metadata, ordering, and threads.
- Lifecycle and modules: plugin phases, module dependencies, callbacks, and cleanup.
- Dependency injection: Guice bindings, providers, and qualifiers.
-
Exposed APIs and multi-module builds:
@Expose,@External, and consumer wiring. - Conditions and decorators: conditional components and method annotations.
- Scheduling: scheduler API, timed methods, and tick conversion.
- Paper integration: listeners, YAML configuration, and platform behavior.
- Velocity integration: proxy lifecycle, Guice, tasks, and plugin setup.
- Text, expressions, and utilities: Adventure text, JEXL, and common helpers.
- Extension points: handlers, interceptors, decorators, and annotation processors.
- API map: public entry points by package and generated artifacts.
- Migration to 3.0: changes from the legacy component model.
- Troubleshooting: build, class loading, injection, and thread issues.
For class and method signatures, build the Javadocs with ./gradlew :core:javadoc :paper:javadoc :velocity:javadoc (or gradlew.bat on Windows). This documentation focuses on behavior, integration, and examples.
Winter 3