https://github.com/linusg/serenityos-emoji-font
😃 The SerenityOS pixel art emojis as a TTF
https://github.com/linusg/serenityos-emoji-font
emoji emoji-font font pixel-art serenityos truetype ttf
Last synced: 21 days ago
JSON representation
😃 The SerenityOS pixel art emojis as a TTF
- Host: GitHub
- URL: https://github.com/linusg/serenityos-emoji-font
- Owner: linusg
- License: other
- Created: 2023-01-16T17:31:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T20:55:20.000Z (3 months ago)
- Last Synced: 2025-03-31T17:19:28.152Z (28 days ago)
- Topics: emoji, emoji-font, font, pixel-art, serenityos, truetype, ttf
- Language: Python
- Homepage: https://linusg.github.io/serenityos-emoji-font/
- Size: 84 KB
- Stars: 83
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# SerenityOS Emoji Font
The [SerenityOS pixel art emojis](https://emoji.serenityos.net/) embedded in a TrueType font.
## Installation & Usage
A nightly build of the font is done automatically via GitHub Actions, you can download it from [here](https://nightly.link/linusg/serenityos-emoji-font/workflows/build/main/SerenityOS-Emoji.ttf.zip).
The font can be installed as a system wide font for emojis, used on a website, and more. The former will depend a lot on your operating system and desktop environment, an example for the latter can be found in the HTML file included in the archive mentioned above.
Please make sure to include a copy of the [`LICENSE`](LICENSE) file when distributing the font!
## What's included?
Everything from [`/res/emoji`](https://github.com/SerenityOS/serenity/tree/master/Base/res/emoji), except for the private use area (PUA) emojis, which are mostly [the yaks](https://yaksplained.org/).
This means that non-standard emojis such as flags and ZWJ combinations (e.g. catdog) are included as well.
## Building locally
Uses [`pixart2svg`](https://gist.github.com/m13253/66284bc244deeff0f0f8863c206421c7) for vectorization of the emoji PNG images and [`nanoemoji`](https://github.com/googlefonts/nanoemoji) to build the font. SVGs are cached, so subsequent runs of the build script will be much faster.
- Clone SerenityOS and export the path of your local checkout:
```shell
export SERENITY_SOURCE_DIR='...'
```
- Install dependencies:
```console
pip install --user -r requirements.txt
```
- Download and patch `pixart2svg`:
```shell
wget https://gist.githubusercontent.com/m13253/66284bc244deeff0f0f8863c206421c7/raw/f9454958dc0a33cea787cc6fbd7e8e34ba6eb23b/pixart2svg.py
for file in patches/*.patch; do
patch -p0 < "$file"
done
```
- Build `SerenityOS-Emoji.ttf`:
```console
python main.py
```
The output files (TTF, `index.html` listing all included emojis) will be in `build/`.
## TODO
This is an initial proof of concept that could be refined in multiple ways:
- Replace `pixart2svg` with something that is more flexible and doesn't need to be patched locally (it's GPL-licensed)
- Find a better approach for vectorization - the current solution of using adjacent SVG rects should in theory yield perfect results but has visible gaps between segments in reality, depending on the renderer and zoom level
## Credit
This wouldn't be possible without all the awesome people creating & refining these emojis for the SerenityOS project! ❤