MittenLib Documentation
Welcome to the MittenLib documentation. MittenLib is a modern, general-purpose framework for writing higher-quality Minecraft plugins, designed with Guice integration and developer experience in mind.
Core Features
- Scalability: Strongly based around the Guice framework, making it particularly well-suited for larger scale projects.
- Modernity: Built around modern practices in Spigot development. It uses Adventure throughout its internals and avoids common pitfalls like static abuse.
- Cross-Version Support: Supports all Minecraft / Spigot versions including and above 1.8.8.
- Config Annotation Processor: One of MittenLib's killer features. Define your config structure in simple interfaces and let the processor generate immutable implementations, loaders, savers, and validators.
Documentation
Tutorials
If you are new to MittenLib, our tutorials are the best place to start:
- Config System Tutorial – A step-by-step guide to using the Config Annotation Processor, from your first config interface to loading it with Guice.
Config Reference
Detailed reference guides for the Config Annotation Processor:
- Getting Started – Quick overview of config generation
- Data Types & Collections - Explore supported types, nested configs, and collections
- Naming & Keys - Customize how Java fields map to config file keys
- Validation - Built-in constraints and custom validators
- Guice Integration - Automatic loading, injection, and hot-reloading
- Persistence - Save configs back to files with smart merging