Font Info
All fonts used for the mod were made in Fontstruct.
However, this game uses modified versions of all fonts
in the game for various reasons. This effectively means
that the fonts that are shipped with the mod are different
than the same fonts distributed through Fontstruct.
One major reason is that Fontstruct cannot kern Shavian glyphs.
Powdered Milk Shavian was designed as a proportional font,
which basically left me with the only option to manually kern
in FontForge.
In addition, the Minispaced in the Fontstruct website is not the same Minispaced
used in the mod. In the original design, to conserve space, the height of ascenders
are different from the height of descenders. In other words,
tall letters are taller than deep letters are deep. I've decided
for the sake of readability to modify Minispaced so that deep
letters are as deep as tall letters are tall.
One other quite major issue is that for some reason, Ren'Py (or Milk2's version of Ren'Py)
cannot display text in the Unicode SMP
(but it can weirdly display text in the private use area for Quikscript just fine for some reason)
So what I did was translate (as in move) the codepoints for Shavian to start at the codepoint for โด.
This basically means that for every single font used, a duplicate copy of the glyphs exists
starting at the codepoint for โด. I'm not sure how to fix Milk2 to properly render Shavian codepoints,
as some of the internal libraries looked kind of intimidating.
To reiterate,
Powdered Milk Shavian will not have kerning in the Fontstruct version,
and Minispaced will not have descenders and ascenders of equal heights in the Fonstruct version.
Newspaper Bleed Shavian will pretty much stay intact (besides the Unicode codepoints being translated)
It goes without saying, but ALL Fonstruct versions of the fonts used in the mod will not be usable ingame.
You must translate the codepoints where ๐ starts at โด for any Shavian font to work with this mod.
You can find the original Fontstruct versions in the Credits
section at the top of the page. You can also download the source files made in FontForge for the fonts used ingame below.
Although I suggest reading the next section (right) for details on the directory structure.
Sources for Creation
Below are the source files used to create the mod.
Keep in mind that they will very likely not work
when used as-is. They are mostly designed for educational
purposes, so you can get an idea on how the mod was made.
It also shows the exact algorithms used for Quikscript contractions.
That said, I will try and provide a brief summary of the different
files used for the mod:
milk2_v2.py - The main way this mod was created was through this custom transliteration
script that runs through the extracted game dialogue files and transliterates
each line one by one using a modified version of dechifro.org's fantastic
Python transliteration script, completely stock Readlex, and a small library
I made for various functions, one of the big ones being Quikscript contractions.
readlex.dict, addendum.dict, trapbathmerger.dict, readlex.json - As mentioned,
these dictionaries are not modified. Instead, they are loaded through the main script (milk2_v2.py)
and each dict entry is modified in memory. milk2_v2.py contains all the dictionary
changes, addendums, etc. to traditional Shavian. It also provides a few dictionary changes
to the Quikscript mode.
The dechifro script (shaw.py) is not included in the mod. This is because a license
was not explicitly given for its usage, so It's assumed
it is explicitly non-redistributable. The main change was to make
the main transliteration stage a function that can be called in any other script.
Other changes include differences in how it interprets dashes and numbers so things like
"3d-modelling" could be interpreted correctly, and other misc things. There is an xdelta3 file where you can use my modified changes to dechifro's "shaw.py"
.ass files represent subtitles for hardsubbing
the video's intro file. FFmpeg was used for burning them.
useful_lib_dan.py - Contains an extremely haphazard list of functions used for Unicode codepoint conversion
(as explained in the Font Info section on the left) and very many numerous other misc functions.
Most functions in it aren't even used.
Some of the files included in the mod are modified compared to their originals.
Of them, milk2_v2.py contains one of the biggest changes. Originally, it contained copyrighted dialogue in Shavian.
It's been removed, and you will need to manually replace each line properly in lines 147-199. Their variable
names give a hint to the dialogue file along with which line number you need to transliterate.
The directory structure is as follows:
[shavian_scripts] contains everything used to create the mod (programs)
[game] contains the source for fonts, images and several xdelta3 files
[game] - A directory structure emulating the mod's actual directory structure.
Inside you will find 4 xdelta3 files to use my modifications for those respective files in the vanilla game's archive.rpa.
You will also find a copy of several of the exact fonts used in the mod, along with Powdered Milk's FontForge source file.
Lastly, you will also find the source files for images used in the mod in Gimp's .xcf format, in game/tl/shavian
[shavian_scripts] - In the folder you will find three files,
useful_lib_dan.py, shaw.xdelta, and convert.txt.
shaw.xdelta is a patch file meant to modify dechifro's shaw.py with the changes required to make the transliteration process work.
Lastly, there is convert.txt, which is not used for anything but a specific script file for testing.
There are two more directories, [dicts] and [milk2].
[shavian_scripts/dicts] - All Readlex dictionaries used to make the mod work.
[shavian_scripts/milk2] - Contains
milk2_v2.py, milk2_singletest.py, and all the .ass files used for hardsubbing.
milk2_singletest.py is only used to test specific, single transliterations, and isn't used for any transliteration steps.
It transliterates anything in [shavian_scripts/convert.txt] using any of your supplied options.
Lastly, there are two folders within this directory, [auto_export] and [auto_import].
[shavian_scripts/milk2/auto_export] - Where your transliterated files will be generated.
[shavian_scripts/milk2/auto_import] - Milk2's vanilla dialogue files are located in a file called archive.rpa.
They are: kompol.rpy, lest.rpy, magaz.rpy, pnc_text.rpy, screens.rpy, script.rpy, telef.rpy and zerk.rpy
You will need to extract these files and place them within [auto_import] for milk2_v2.py
to automatically transliterate everything.
The game's source dialogue files are not included with the mod.
Instead, you will have to extract them yourself.
An explanation for how this is done will not be given.
milk2_v2.py uses a temporary folder located in R:/ - you will NEED to change this to something else, otherwise you'll get an error.
Finally, game code changes were made to the vanilla game's script.rpy, gui.rpy, pnc.rpy and art.rpy files. I cannot distribute these files.
However, as stated earlier, there are xdelta3 files in [game] that you can use to modify those files with the changes I made..
the "game" folder contains the images used in the game.
If you do everything perfectly, you can actually make a perfect recreation of the mod with the exact method I used (with the exception of the FFmpeg command I lost).
I don't see much purpose in doing so however, unless you wanted to make your own mod. (Fully functional handwritten-style Senior Quikscript mod anyone?)
