A powerful and flexible configuration API for Minecraft mods, supporting both Fabric/Forge and NeoForge platforms with automatic UI generation and internationalization (i18n) support.
- Multi-Platform Support: Works seamlessly on both Fabric and NeoForge
- Automatic UI Generation: Integrates with Cloth Config for automatic configuration screen generation
- Internationalization (i18n): Built-in support for multiple languages
- Hot Reload: Automatic configuration file watching and reloading
- Validation: Comprehensive configuration validation with annotations
- Type-Safe: Strongly typed configuration with compile-time safety
- Easy Integration: Simple API for mod developers
- Client/Server Separation: Support for client-only and server-only configurations
- Migration Support: Built-in configuration migration and versioning
- Rich Annotations: Extensive annotation system for fine-grained control
For comprehensive documentation, please visit our documentation site:
To get started with Tritium Configuration, please visit our comprehensive Getting Started Guide.
The documentation covers:
- Adding Tritium Configuration as a dependency
- Creating your first configuration class
- Registering configurations for Fabric and NeoForge
- Using annotations for validation and organization
- Generating automatic UI screens
- Setting up internationalization
For detailed API usage and examples, please refer to the documentation site.
- Java 21 or higher
- Gradle (included via wrapper)
# Build all platforms
./gradlew build
# Build Fabric only
./gradlew :fabric:build
# Build NeoForge only
./gradlew :neoforge:build- Minecraft: 1.21+
- Java: 21+
- Fabric Loader: 0.15.11+ (for Fabric)
- NeoForge: 21.0.110-beta+ (for NeoForge)
- Cloth Config: 15.0.140+ (automatically included)
This project is licensed under the MIT License - see the LICENSE.txt file for details.
- ZCRAFT - Initial work and maintenance
- QianMo0721 - Maintainer, responsible for fixing bugs and optimizing code
Contributions are welcome! Please feel free to submit a Pull Request.
For questions, issues, or feature requests, please visit our GitHub Issues page.
Made with ❤️ by the CraftAmethyst Organization.