Getting Started
CLI Information
- Coordinate:
dev.kordex.i18n:i18n - Current Version:
- Minimum Java:
17 - Repo:
https://releases-repo.kordex.dev
Code Generation
This framework is a lot more convenient when you use our code generators. The easiest way to set one up is via our Gradle plugin, but if you're not using Gradle or can't use the plugin for some reason, you can integrate our code generators yourself.
Project Setup
First, follow these basic setup steps:
- Ensure you have a JDK installed, version 17 or later. If you don't already have one, we recommend Eclipse Temurin.
- Add the i18n framework to your project's dependencies:
Next Steps
Once you've set up the dependency, you'll need to configure the framework and set up your translation bundles:
- Learn how to configure the framework.
- Learn about translation bundles, and how to use them.
- Learn about translation keys, and how to use them.
- Learn about the various registries, including the class-loader registry.
- Set up a code generator, either by using our Gradle plugin, or manually integrating our API or CLI.
Licencing
The i18n framework is licenced under the Mozilla Public License. For more information on this licence and why we picked it, see this page.