HunterPie supports different languages other than English, if you want to localize it to another language make sure to read this because it covers everything you need to know to make your own localization file.
Localizations
The supported languages are:
| Language | Translated (%) |
|---|
Getting Started
Requirements
- A decent text editor, I personally recommend:
- The default strings file, you can find it here
Tip: Do not use the default Windows’s notepad, that can cause file encoding issues and will make HunterPie fail to load your file. Make sure your encoding file is UTF-8.
Localizing
Now thhat you have the requirements, it’s time to start translating! Use the en-us.xml you downloaded in the last step as a base file, it contains all the currently supported strings that are used by both the HunterPie client and the Overlay and the integrations.
Warning: Make sure to rename your file to something else so it doesn’t conflict with the default files. If you don’t rename it, there’s a risk your local file will be overwritten during the auto-update process.
Do not touch the first line of the XML Document, that is telling our XML parser the version and file encoding we are using. It should ALWAYS be the first line of the file and should always look like this:
1
2
<?xml version="1.0" encoding="utf-8" ?>
<!-- Comments can be added ONLY after the tag -->
Next step is to set the language name, you can do it in the next Tag by changing the value of the lang attribute.
1
2
3
4
5
<!-- Before -->
<Strings lang="English">
<!-- After -->
<Strings lang="Japanese">
Now we’re can translate the rest of the file, most localization Tags have three attributes:
- Id: Used internally by HunterPie to query the string and description. DO NOT TOUCH THIS VALUE
- String: The actual string that will be shown in HunterPie’s interface.
- Description: This one is only used in places where there can be a tooltip, e.g: Settings, Buttons
Please, try to keep all translations as accurate as possible with the in-game strings (especially abnormalities and monster names). You can shorten long strings as long as they don’t become difficult to understand.
E.g:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<!-- Before -->
<Rise>
<Monster Id="0" String="Rathian"/>
<Monster Id="1" String="Apex Rathian"/>
<Monster Id="2" String="Rathalos"/>
<Monster Id="3" String="Apex Rathalos"/>
<Monster Id="4" String="Khezu"/>
<Monster Id="5" String="Basarios"/>
[...]
<!-- After -->
<Rise>
<Monster Id="0" String="リオレイア"/>
<Monster Id="1" String="ヌシ・リオレイア"/>
<Monster Id="2" String="リオレウス"/>
<Monster Id="3" String="ヌシ・リオレウス"/>
<Monster Id="4" String="フルフル"/>
<Monster Id="5" String="バサルモス"/>
[...]
XML Special Characters
XML has some characters that should be replaced by their escaped versions in order for it to work. This is because these characters are used in the XML’s structure itself, and the parser has a hard time figuring out whether it’s a XML character or if it’s just a normal character.
| Character | Replaced by |
|---|---|
| & | & |
| < | < |
| > | > |
| ” | " |
| ’ | ' |
E.g:
1
2
3
4
5
<!-- This will give us an error -->
<Abnormality Id="ABNORMALITY_ATTACK_DEF_UP" String="Attack & Def. Up"/>
<!-- This will work -->
<Abnormality Id="ABNORMALITY_ATTACK_DEF_UP" String="Attack & Def. Up"/>
Sending my localization
Now that you’ve finished translating all strings, you can open a Pull Request to HunterPie’s repository or send it in the #translation-discussion channel in HunterPie’s official Discord Server.
Making your own Pull Request is the preferred way, since it will also mark you as one of HunterPie’s contributors in GitHub, but if you have no Git experience sending the file directly to me on Discord is also fine.