Cavemanon/Wani-Translation-Kit
25
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

Update README to detail font merging

Browse Source
This commit is contained in:
Mappening
2024-09-13 07:32:04 -05:00
parent a8937016e0
commit 117dd3eeaf
1 changed files with 28 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.txt
View File

@ -240,6 +240,34 @@ Alternatively, create an issue on the Wani demo repository and leave a link for
https://git.cavemanon.xyz/Cavemanon/IWaniHugThatGator-Demo-Public
--------------------------------------------
- FONTS -
--------------------------------------------
We've put the onus on translators to handle fonts so text in general is simple to handle. Wani uses mega-fonts that incorporate all characters for supported languages, and if your language is unfortunate enough to not use cryllic or latin characters, you'll have to add to these fonts. The 3 fonts that are used by Wani are in:
-game/gui/FallingSky.otf
-game/gui/phone_assets/Aller_Rg.ttf
-game/gui/phone_assets/Metropolis-Regular.otf
Use a program like Font Forge (https://fontforge.org) to edit these fonts and put in your language's characters, either by creating them yourself or copying them from another font. If you go with the latter option, make sure your font comes from a permissive font license such as OFL or Public Domain that allows you to do this, and provide a link to the font download as proof.
The following instructions apply only to fontforge:
1. Open the font you want to edit.
2. (Optional) Verify that that settings like the EM size are the same between the fonts, so characters aren't weirdly sized. Otherwise, change them so they are so.
2. Go to "Element" -> "Merge Fonts..." at the top bar.
3. Select your language's font to merge characters from.
4. At the pop-up to retain kerning, you'll generally want to select yes unless the font looks weird in-game.
5. Go to "File" -> "Generate Fonts..." and save the updated font in the filetype it was in. Put the font in-game and verify it looks good.
If you're worried about accidentally replacing existing characters, you can compare fonts by going into "Element" -> "Compare Fonts..." while having 2 fonts open in fontforge. Deselect everything but "Compare Outlines" and tick on "Add Missing Glyphs", then click OK to show highlighted missing characters between the 2 fonts. To make checking them bearable, go to "Encoding" -> "Compact (hide unused glyphs)".
--------------------------------------------
- MISCELLANEOUS -
--------------------------------------------
@ -252,8 +280,6 @@ You can find out more about them on Renpy's wiki, which can be found on Renpy's
Undoubtedly, there's going to be some quirks that will go beyond simple string replacement when it comes to suiting any given language, such as fonts, localization, text that becomes too long or short, etc. Some of these can be alleviated with Ren'Py's text tags, which can change things like the size of a text. Deal with them in any way you think is necessary, or make an issue on the Wani Demo repo on our git for things that can be tweaked to be more language agnostic.
Fonts, however, are a special case since we've put the onus on translators to handle them so text in general is simple to handle. Wani uses mega-fonts that incorporate all characters for supported languages, and if your language is unfortunate enough to not use cryllic or latin characters, you'll have to add to these fonts. The 3 fonts that are used by Wani are in "game/gui/FallingSky.otf", "game/gui/phone_assets/Aller_Rg.ttf", "game/gui/phone_assets/Metropolis-Regular.otf". Use a program like Font Forge (https://fontforge.org) to edit these fonts and put in your language's characters, either by creating them yourself or copying them from another font. If you go with the latter option, make sure your font comes from a permissive font license such as OFL or Public Domain that allows you to do this, and provide a link to the font download as proof.
When you're finished with the translation, full credits should go in the about section in the extras menu, located in screens.rpy. There should be a comment in the about section on how to put in names (Edit the actual file, to add in your names alongisde the other language contributers, then re-generate strings as necessary to translate the titles).
If you wish to put your names in your credit sequence, you can replace the strings in the translation file for credits.rpy "Stock sounds acquired at:" with "Translation by:" and put in your names in place of the stock sound sites. Due to the nature of replacing strings this way, it's really jank - Do not make your names go to a new line or use new line terminators to add more names, if you REALLY need to add more than 3 names, just seperate them by commas on any given line. Only put in the people who have contributed most, because it shouldn't be a crowded mess, especially so the E4 credits image these credits appear in isn't super obstructed.