From 5a251ad3819d58840f09525beac2db7e8e205c6e Mon Sep 17 00:00:00 2001 From: minjaesong Date: Sat, 7 Mar 2026 12:53:45 +0900 Subject: [PATCH] readme update --- README.md | 19 ++++++++++--------- src/assets/cyrilic_serbian_variable.tga | 2 +- src/assets/cyrilic_variable.tga | 2 +- src/assets/latinExtD_variable.tga | 2 +- work_files/cyrilic_serbian_variable.psd | 4 ++-- work_files/cyrilic_variable.psd | 4 ++-- work_files/latinExtD_variable.psd | 4 ++-- 7 files changed, 19 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 12ec406..9e70fe3 100755 --- a/README.md +++ b/README.md @@ -4,15 +4,18 @@ This font is a bitmap font used in [my game project called Terrarum](https://github.com/minjaesong/Terrarum) (hence the name). The font supports more than 90 % of european languages, as well as Chinese, Japanese, and Korean. -The JAR package is meant to be used with LibGDX (extends ```BitmapFont``` class). If you are not using the framework, please refer to the __Font metrics__ section to implement the font metrics correctly on your system. +The font is provided in following formats: + +* **OTF** — This is the version you want most likely. It's compatible with anything that supports OpenType fonts. +* **WOFF2** — This is OTF font repackaged as a web font. You will want this if you want to use it on a web page. +* **JAR** — This is the version you want if you work with LibGDX. (extends ```BitmapFont``` class) The issue page is open. If you have some issues to submit, or have a question, please leave it on the page. #### Notes and Limitations -- Displaying Bulgarian/Serbian variants of Cyrillic requires special Control Characters. (`GameFontBase.charsetOverrideBulgarian` -- U+FFFC1; `GameFontBase.charsetOverrideSerbian` -- U+FFFC2) +- (JAR only) Displaying Bulgarian/Serbian variants of Cyrillic requires special Control Characters. (`GameFontBase.charsetOverrideBulgarian` -- U+FFFC1; `GameFontBase.charsetOverrideSerbian` -- U+FFFC2) - All Han characters are in Mainland Chinese variant. There is no plan to support the other variants unless there is someone willing to do the drawing of the characters - Only the Devanagari and Tamil has full (as much as I can) ligature support for Indic scripts -- Bengali script does not have any ligature support -- Slick2d versions are now unsupported. I couldn't extend myself to work on both versions, but I'm still welcome to merge your pull requests. ### Design Goals @@ -25,11 +28,9 @@ The issue page is open. If you have some issues to submit, or have a question, p - Go ahead to the [release tab](https://github.com/minjaesong/Terrarum-sans-bitmap/releases), and download the most recent version. It is **not** advised to use the .jar found within the repository, they're experimental builds I use during the development, and may contain bugs like leaking memory. -## Using on your game +## Using on your LibGDX project -- Firstly, place the .jar to your library path and assets folder to the main directory of the app, then: - -### Using on LibGDX +- Firstly, place the .jar to your library path, then: On your code (Kotlin): @@ -40,7 +41,7 @@ On your code (Kotlin): lateinit var fontGame: Font override fun create() { - fontGame = TerrarumSansBitmap(path_to_assets, ...) + fontGame = TerrarumSansBitmap(...) ... } @@ -62,7 +63,7 @@ On your code (Java): Font fontGame; @Override void create() { - fontGame = new TerrarumSansBitmap(path_to_assets, ...); + fontGame = new TerrarumSansBitmap(...); ... } diff --git a/src/assets/cyrilic_serbian_variable.tga b/src/assets/cyrilic_serbian_variable.tga index d766028..6a92087 100755 --- a/src/assets/cyrilic_serbian_variable.tga +++ b/src/assets/cyrilic_serbian_variable.tga @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4d3169bfffbe2cddc7a788bac270f19072fb31246908dccb3c088becc2ce975e +oid sha256:12c3ef14786627310688e4c3c8d1acf6d15763253c4549a7be5ed9f7156bdbee size 122898 diff --git a/src/assets/cyrilic_variable.tga b/src/assets/cyrilic_variable.tga index cd4968d..6dad9d9 100755 --- a/src/assets/cyrilic_variable.tga +++ b/src/assets/cyrilic_variable.tga @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3ddadad1981ecfbae06d828a8533208dd99f0222c811c7d2948a3e91537a0241 +oid sha256:ddc9396b96aa8ff48c3b996caedae5e5a820c5774992eec8395784fef7911610 size 389138 diff --git a/src/assets/latinExtD_variable.tga b/src/assets/latinExtD_variable.tga index d176f0c..4c3c401 100644 --- a/src/assets/latinExtD_variable.tga +++ b/src/assets/latinExtD_variable.tga @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:dfab817cff092f7bf8102f91facec54aff567c3221ec18507a281ded79f64917 +oid sha256:f9e2af1ae604cadc8459aec306cd5325f4dc1bfae7b63ffd6f9346b7299d76ff size 286738 diff --git a/work_files/cyrilic_serbian_variable.psd b/work_files/cyrilic_serbian_variable.psd index dae65ac..0cd05a5 100644 --- a/work_files/cyrilic_serbian_variable.psd +++ b/work_files/cyrilic_serbian_variable.psd @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:19b49762a7900ee7ea40796b1fda5d79e4464d89e4ae81aa8cf5755c6faf5335 -size 118492 +oid sha256:f9e5dd85b601cf2d76cdd928ebbfb8bc55edf727722f822bf91a3b0df9b3c0bd +size 119337 diff --git a/work_files/cyrilic_variable.psd b/work_files/cyrilic_variable.psd index f0470b3..493278b 100644 --- a/work_files/cyrilic_variable.psd +++ b/work_files/cyrilic_variable.psd @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f59ecbcc93c17234898031c7f62c31c3d921e6793d6ecbc6018cbff2e3e5466b -size 417607 +oid sha256:ce7c9c64021ddd7fe7131e995398e7009fafcd033ed94be3cf86a620d5283b11 +size 418093 diff --git a/work_files/latinExtD_variable.psd b/work_files/latinExtD_variable.psd index d03352a..3581720 100644 --- a/work_files/latinExtD_variable.psd +++ b/work_files/latinExtD_variable.psd @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a3325bf43588e790c2d41120113ee093fc250031d86fca098a250deebf5f8884 -size 328128 +oid sha256:c978e28c87b130f7f243f6b60269bb61930cb5457cb10ffea4ecca2982fc2f47 +size 328120