README.md

Ruby Font Creator

Font creator to help students learn and read foreign languages faster by appending pronunciation or meaning to each glyph.

Font Samplers

This archive contains additional font files used in the samplers: PinyinFonts.zip

The base fonts they are created from are shown in font_summary.md.

Pinyin-Tigris-Bottom-Handwritten

• Font file: Pinyin-Tigris-Bottom-Handwritten.ttf

Pinyin-Tigris-Left-Handwritten

• Font file: Pinyin-Tigris-Left-Handwritten.ttf

Pinyin-Tigris-Top-Handwritten

• Font file: Pinyin-Tigris-Top-Handwritten.ttf

Pinyin-Leo-Bottom-Serif

• Font file: Pinyin-Leo-Bottom-Serif.ttf

Pinyin-Leo-Left-Serif

• Font file: Pinyin-Leo-Left-Serif.ttf

Pinyin-Leo-Top-Serif

• Font file: Pinyin-Leo-Top-Serif.ttf

Pinyin-Onca-Bottom-Serif

• Font file: Pinyin-Onca-Bottom-Serif.ttf

Pinyin-Onca-Left-Serif

• Font file: Pinyin-Onca-Left-Serif.ttf

Pinyin-Onca-Top-Serif

• Font file: Pinyin-Onca-Top-Serif.ttf

Pinyin-Catus-Bottom-Sans

• Font file: Pinyin-Catus-Bottom-Sans.ttf

Pinyin-Catus-Left-Sans

• Font file: Pinyin-Catus-Left-Sans.ttf

Pinyin-Catus-Top-Sans

• Font file: Pinyin-Catus-Top-Sans.ttf

Known issues

• The code runs tvery slowly. In Windows or GitHub Codespaces or Google Colab, cannot finish. Only ways to build full fonts is using GitHub Action.

• On Windows, best to use VS Code WLS Extension, and connect to Window Subsysem Linux to develop. Otherwise, Node and Python code is hard to run together.

Features

languages	preview	state	repository	base-font
Chinese		✔️	hanzi-pinyin-font	DroidSansFallbackFull
Tifinagh	-	🏃‍	hanzi-pinyin-font	DroidSansFallbackFull
🗣️ request new one	-	-	-	Please provide an open-source font

Legend: ⏸→ 🏃‍→ ✔️

Install

Requirements: nodejs, yarn or npm.

yarn install

Usage

Requirements: a JSON file describing codepoint-glyph-gloss tuple (e.g. src/data.json).

yarn build

Custom config:

yarn build --config ./src/config/default.js

Custom data:

yarn build --data ./path-to/data.json

Custom Font Name:

yarn build --font-name 'custom-font-name'

ℹ️ maintenance tasks available are in the [makefile][./makefile], run make to see possible actions.

Data Structure

A list of objects, each describing a glyph, with the following 3 elements:

1. a unicode codepoint ;
2. a base glyph ;
3. a ruby text.

Example:

[
  {
    "codepoint": "U+03B1",
    "glyph": "α",
    "ruby": "alpha"
  }
]

Font

This project use fonts under open-source licenses : DejaVuSans, DroidSansFallbackFull, Noto Sans CJK.

License

Apache License 2.0

Contributors

• Édouard Lopez ;
• Hugo Lopez