Changes between Initial Version and Version 1 of Adding_font_support

Timestamp:

May 12, 2014, 2:55:18 PM (10 years ago)

Author:

sanderd17

Comment:

--

Adding_font_support

@@ +1 @@
+In this page, we're going to follow the work it took to add east-asian fonts.
+
+= Font rendering =
+
+Fonts in Pyrogenesis are prerendered by the fontbuilder tool. 
+
+First you need to do download the right font files (ttf, otf, ...), and place them in the [source:ps/trunk/binaries/data/tools/fontbuilder/fonts fonts] directory. F.e., to support east-asian fonts, we downloaded the [http://fonts.jp/hanazono/ Hanazono fonts].
+
+Then you need to add the font to the [source:ps/trunk/source/tools/fontbuilder2/fontbuilder.py fontbuilder] itself. If you add the font files to the back of the list, they will be used as fallback. F.e.
+{{{
+Sans = (["LinBiolinum_Rah.ttf","FreeSans.ttf", "HanaMinA.ttf"], FontLoader.FT_LOAD_DEFAULT)
+}}}
+to use the hanazono font HanaMinA.ttf as fallback for the sans style.
+
+If you don't want to overwrite the current fonts, but rather distribute them as a mod, it's best to change the output directory to the mod you want in the last line of the fontbuilder.
+
+By running the fontbuilder with Python2, 
+{{{
+python2 fontbuilder.py
+}}}
+the fonts will be prerendered, and added in the output directory you defined (by default the correct path in the public mod).
+
+= Font caching =
+
+If you want to distribute the fonts as a separate mod, it's best to cache them, else users will only see grey text on their first run. Caching should be done with the archivebuild tool available in Pyrogenesis. Note that for distribution, it's also best to enable the compression flag, because cached dds files tend to be big, and seem to compress rather well.
+
+F.e., for the east-asian locales mod:
+{{{
+binaries/system/pyrogenesis -archivebuild=binaries/data/mods/east-asian-locales -archivebuild-output=ebinaries/data/mods/east-asian-locales/ast-asian-locales.zip -archivebuild-compress
+}}}
+Which will result in a cached, compressed east-asian-locales.zip file, ready for distribution.
+
+= Testing your fonts =
+
+To make sure you test the final version, first (re)move all old files (s.a. the png files the fontbuilder made). Then place your zip in the same directory structure as the released public mod (so mods/east-asian-locales/east-asian-locales.zip for our test), and run pyrogenesis with the mod enabled.
+{{{
+./pyrogenesis -mod=east-asian-locales
+}}}