LocaleAPI Codacy Badge

What is it for? Developers using this API can provide the ability to simultaneously use multiple languages. For example. On your server there are players from different countries and they understand only their language. If there is a localization file in which there will be messages corresponding to the client language chosen by them, they will see the messages of your plugin in that language.

For server admin:

All localization files are saved in the following path, where “pluginid” is the directory for the localization files of a particular plugin. ./{ConfigDir}/localeapi/{pluginid}/[LocaleFiles]
This only applies to plugins that use LocaleAPI.
You can add translation files you need to the plugin localization directory. When you add a localization file, it will be downloaded automatically. If you make changes to existing files, they will also be automatically reloaded. The load/reload operation cannot be performed more than once every 10 seconds. This time limit has been added to eliminate the possibility of server performance degradation.

For developers:

The localization file name must be in the format en-US, ru-RU, etc. Select the file type depending on which configuration you prefer to choose. For the correct work of the plugin is necessary to generate a default localization file - en-US.

Test plugin -> https://github.com/SawFowl/LocaleTestPlugin/tree/API10
javadoc -> https://sawfowl.github.io/LocaleAPI/

public class Main {
	private Main instance;
	private Logger logger;
	private static LocaleService localeService;
	private PluginContainer pluginContainer;
	public LocaleService getLocaleService() {
		return localeService;

	public Main(PluginContainer pluginContainer, @ConfigDir(sharedRoot = false) Path configDirectory) {
		this.pluginContainer = pluginContainer;

	// Get API. Variant 1. This happens in event `ConstructPluginEvent`.  It's recommended if LocaleAPI is mandatory.
	public void onLocaleServisePostEvent(LocaleServiseEvent.Construct event) {
		instance = this;
		logger = LogManager.getLogger("PluginName");
		localeService = event.getLocaleService();

	// Get API. Variant 2. This happens in event `StartedEngineEvent<Server>`. It's recommended if LocaleAPI is optional.
	// In this case, you can specify another class as the event listener.
	public void onLocaleServisePostEvent(LocaleServiseEvent.Started event) {
		localeService = event.getLocaleService();

	public void testLocales() {
		if(!localeService.localesExist(instance)) {
			localeService.createPluginLocale(pluginContainer, ConfigTypes.HOCON, Locales.DEFAULT);
			//					^^ pluginContainer or "pluginid".
			localeService.createPluginLocale(pluginContainer, ConfigTypes.HOCON, Locales.DEFAULT);
			getLocaleUtil(Locales.DEFAULT).checkString("Your string for localization.", "Optional comment", "Path");
		// Get message from locale. You can get and use the player's localization 'player.locale();'.

	public PluginLocale getPluginLocale(Locale locale) {
		return localeService.getOrDefaultLocale(pluginContainer, locale);
repositories {
	maven { 
		name = "JitPack"
		url 'https://jitpack.io' 
dependencies {
	implementation 'com.github.SawFowl:LocaleAPI:3.2'
	// Or if the JitPack repository is not available.
	implementation fileTree(dir: 'libs', include: '*.jar')

Category: Developer Tools

Published on Feb 14, 2022




total downloads

Promoted Versions