Localization
UltiTools has built-in Chinese and English support. You can also customize language files.
Setting the Language
Edit plugins/UltiTools/config.yml:
language: "en" # zh for Chinese, en for EnglishRun /ul reload to apply.
Customizing Messages (from 6.3.0)
Do not edit the official language files
The official language files belong to UltiTools, and an official file edited in place is restored to the bundled version at every start. To customise messages, copy an official file, rename it, and select the new name in the main config.
Where the official language files are
| Messages of | Folder | Official files |
|---|---|---|
| UltiTools itself | plugins/UltiTools/lang/ | zh.json, en.json |
| Each module | plugins/UltiTools/pluginConfig/<module>/lang/ | zh.json/en.json or zh.yml/en.yml, depending on the module |
Three steps
Copy: in the folder whose messages you want to change, copy an official file under a new name that starts with its language code and a hyphen, keeping the extension. The name before the extension must start with an ASCII letter or digit and contain only ASCII letters, digits,
-and_; a name such asen.myserveris rejected and no custom file is read. For example, copyen.jsontoen-myserver.json.Edit: edit the copy. It may keep only the entries you change.
Select: set this in
plugins/UltiTools/config.yml:yamllanguage: "en-myserver"Then restart the server or run
/ul reload.
That one setting applies to UltiTools and to every module. Put a copy with the same name in the lang/ folder of each module whose messages you want to change; a module without one keeps using its official English.
Messages your copy does not contain
Every entry your copy lacks comes from the official language its name starts with: en-myserver uses the official en, zh-myserver the official zh. So a copy may contain only the few lines you change, and every other message still shows.
A name that starts with no shipped language code (for example myserver) uses English for the missing messages, and the console shows warnings suggesting a better name: one from UltiTools and one from each module that uses this fallback.
After an upgrade, if an entry in your copy has a different number of %s/%d placeholders than the new official text, changes a placeholder type at the same argument position (for example %s to %d or the reverse, even with the same count), or lacks a placeholder such as {PLAYER} that the official text has (placeholders you added yourself are kept), that entry uses the official text and the console shows one warning naming the file and the entry. Your file is not changed; update that entry from the new official file.
Give your copy a name no module ships, such as en-myserver. A plain language code other than en and zh (such as fr) may match a language file a later release ships; your file would then be treated as an official file and restored (your version kept as .bak).
Your file is never overwritten
A custom file such as en-myserver.json is yours: no start, /ul reload, upgrade or module update ever writes, replaces or backs it up. The explanatory comments written into module configuration files also use your custom wording. Before deleting or renaming a custom file, switch language back to an official code and restart or run /ul reload while the custom file still exists; otherwise those comments can keep the custom wording.
If you edited an official file directly
At every start, an official file that differs from the bundled version is restored to it, and your edited file is kept in the same folder as <file>.bak (then .1.bak, .2.bak, and so on, never overwriting an existing file). The console shows one line saying the file was restored, where the backup is, and how to customise instead. /ul reload does the same for UltiTools' official files and for each module's official file of the language in use.
To get your edits back, copy the .bak file to a custom file (for example en-myserver.json) and select it in the main config. Do not rename the .bak back: it would be restored again at the next start.
An official file that is read-only, or a symbolic link, is not restored; the console shows a line saying so.
Before 6.3.0
Before 6.3.0, UltiTools' own messages were never read from a file on disk and modules did not support custom names; a module's official language file you edited directly was kept. On the first start after upgrading from 6.2.x, edited official files of every shipped language in each module are restored, not just the selected language. Look for .bak files in each module's lang/ folder and copy them to custom files as described above.
Ling Bao