This is not a plugin, it is for developers only, do not install it on your server. However, information is available below for server owners that use plugins that utilise Languagy.
Languagy is a Spigot API to make it easy for plugins to support player-individual languages.
Translations are retrieved from your plugin based on the player's selected language in their client settings. All Minecraft client languages are supported.
Note: Languagy is not intended to automatically translate - you are expected to provide translations yourself via files. Languagy is just a helpful wrapper to handle all that.
How it works, internally.
![[IMG]](/proxy/image?url=https%3A%2F%2Ffortitude.islandearth.net%2Flanguagy4.png)
Why?
Supporting multiple languages is rare in servers these days. When it does happen, this is done through obscure GUIs. Languagy makes this simple by automating the process to have no impact on your users, improving the quality of your server. It is simple to use and can be integrated into plugins easily and cleanly, including via gradle/maven shading.
Supported plugins
Want your plugin here? PM me, post in the discussion, or leave a review.
Shading
Languagy must be shaded and relocated.
Gradle (Kotlin DSL):
repositories {
maven ( "https://repo.convallyria.com/releases" )
}
dependencies {
implementation ( "com.convallyria.languagy:api:3.0.2" ) {
exclude ( "com.convallyria.languagy.libs" )
}
}
tasks {
shadowJar {
relocate ( "com.convallyria.languagy", "YOUR_PACKAGE.libs.languagy" )
}
}
Maven:
Please also exclude & relocate on maven - I don't have an example here as I do not use Maven, so please find that for yourself. The gradle config shows what you need to exclude & relocate from/to.
<repositories>
<repository>
<url>https://repo.convallyria.com/releases </url>
</repository>
</repositories>
<dependency>
<groupId>net.islandearth.languagy </groupId>
<artifactId>api </artifactId>
<version>3.0.2 </version>
</dependency>
API Usage - updated for v3
Once you have added Languagy as a dependency as described in the above section, you will need to do a few things to get it to work.
In your plugins onEnable, you'll want to initialise a new Translator;
There are several ways to initialise the translator, please
see the JavaDocs for information on this.
Important:
In your onDisable method, you should always call Translator#close. This ensures the file watch system is closed down properly. Expect problems if you do not do this!
You can now use language-specific features and get translations via Translator#getTranslationFor.
To colour translations, you will want to use Translation#colour, or you can simply use the Translation#send method which will handle this all for you and use Player#sendMessage.
If you do not have a translated language file for the player's target locale, then it will fall back to the default provided, which will by default be English.
You'll want to extract your language files from your jar. I have an example class in my ForcePack plugin here: https://gitlab.com/SamB440/ForcePac...orcepack/spigot/translation/Translations.java
Bug Reporting/Support/Questions
Issues should be filed by hitting the issues tab in gitlab. Please make sure you search your issue before opening a new ticket.
All opened tickets that are bug reports require a debug log that includes logs of the issue in question.
FAQ:
Compiling
Languagy builds on Java JDK 1.8 and uses Gradle to manage dependencies.
Via bash:
Output jar is in build/libs.
Languagy is a Spigot API to make it easy for plugins to support player-individual languages.
Translations are retrieved from your plugin based on the player's selected language in their client settings. All Minecraft client languages are supported.
Note: Languagy is not intended to automatically translate - you are expected to provide translations yourself via files. Languagy is just a helpful wrapper to handle all that.
How it works, internally.
Why?
Supporting multiple languages is rare in servers these days. When it does happen, this is done through obscure GUIs. Languagy makes this simple by automating the process to have no impact on your users, improving the quality of your server. It is simple to use and can be integrated into plugins easily and cleanly, including via gradle/maven shading.
Supported plugins
Want your plugin here? PM me, post in the discussion, or leave a review.
Shading
Languagy must be shaded and relocated.
Gradle (Kotlin DSL):
Code (Kotlin):
repositories {
maven ( "https://repo.convallyria.com/releases" )
}
dependencies {
implementation ( "com.convallyria.languagy:api:3.0.2" ) {
exclude ( "com.convallyria.languagy.libs" )
}
}
tasks {
shadowJar {
relocate ( "com.convallyria.languagy", "YOUR_PACKAGE.libs.languagy" )
}
}
Please also exclude & relocate on maven - I don't have an example here as I do not use Maven, so please find that for yourself. The gradle config shows what you need to exclude & relocate from/to.
Code (XML):
<repositories>
<repository>
<url>https://repo.convallyria.com/releases </url>
</repository>
</repositories>
<dependency>
<groupId>net.islandearth.languagy </groupId>
<artifactId>api </artifactId>
<version>3.0.2 </version>
</dependency>
Once you have added Languagy as a dependency as described in the above section, you will need to do a few things to get it to work.
In your plugins onEnable, you'll want to initialise a new Translator;
Code (Java):
private Translator translator
;
public Translator getTranslator ( ) {
return translator ;
}
@Override
public void onEnable ( ) {
this. translator = Translator. of ( this ) ;
}
@Override
public void onDisable ( ) {
translator. close ( ) ; // IMPORTANT! See below.
}
public Translator getTranslator ( ) {
return translator ;
}
@Override
public void onEnable ( ) {
this. translator = Translator. of ( this ) ;
}
@Override
public void onDisable ( ) {
translator. close ( ) ; // IMPORTANT! See below.
}
Important:
In your onDisable method, you should always call Translator#close. This ensures the file watch system is closed down properly. Expect problems if you do not do this!
You can now use language-specific features and get translations via Translator#getTranslationFor.
To colour translations, you will want to use Translation#colour, or you can simply use the Translation#send method which will handle this all for you and use Player#sendMessage.
If you do not have a translated language file for the player's target locale, then it will fall back to the default provided, which will by default be English.
You'll want to extract your language files from your jar. I have an example class in my ForcePack plugin here: https://gitlab.com/SamB440/ForcePac...orcepack/spigot/translation/Translations.java
Bug Reporting/Support/Questions
Issues should be filed by hitting the issues tab in gitlab. Please make sure you search your issue before opening a new ticket.
All opened tickets that are bug reports require a debug log that includes logs of the issue in question.
FAQ:
- Do I need to restart/reload to update messages? No, the file is kept updated so you never need to restart/reload, you can change it whilst the server is running and see the changes take effect instantly.
- Performance? I have ran Languagy on servers with 70+ players and also smaller servers, and the impact is extremely minimal. Languagy also works asynchronously where possible.
Compiling
Languagy builds on Java JDK 1.8 and uses Gradle to manage dependencies.
Via bash:
Code (Text):
cd Languagy
./gradlew build
./gradlew build
Do not report issues in reviews! Join our Discord or create an issue.
Resource Information
Author:
----------
Total Downloads:
55,542
First Release:
Oct 18, 2018
Last Update:
Mar 30, 2023
Category:
---------------
All-Time Rating:
Find more info at gitlab.com...
6 ratings
Version
-----
Released:
--------------------
Downloads:
------
Version Rating:
----------------------
-- ratings