EmojiFonts

Python and shell scripts to backport and theme Apple Color Emoji font.

Prerequisites

• Python 3.7 or later
• pip
• fonttools (pip3 install fonttools[repacker])
• afdko (pip3 install afdko)
• pngquant (brew install pngquant)

Prerequisites (Theming)

• ImageMagick (brew install freetype imagemagick)
• librsvg (brew install librsvg)
• inkscape (brew install inkscape)
• php (brew install php)

Before anything

1. Copy Apple Color Emoji.ttc from /System/Library/Fonts of your macOS instance to the root of this repository and rename it to AppleColorEmoji_macOS.ttc.
2. Copy AppleColorEmoji font from your iOS instance to the root of this repository and rename it to AppleColorEmoji_iOS.ttc. Read here for the exact file path.
3. Apply this patch to sbixGlyph.py of your fonttools library.
4. Execute prepare.sh to create emoji TTF files and tables. Run this once.

Building Apple Color Emoji font

Execute apple.sh, you will get [email protected] (for iOS 10 and above) and [email protected] (for iOS 9 and below) under apple directory.

Optimization

The script apple.sh uses pngquant to optimize the images with little to none changes to the quality. The Apple emoji font sizes are reduced by nearly 50% using this method.

Scripts (Python)

EmojiFonts deals with certain font tables; mainly GDEF and sbix.

shift-multi.py resizes and shifts the multi-skinned emojis that pair up as one, including couples and handshake, to have them displayed on iOS 13 and below correctly where there is no render logic to automatically place the pair close together.

GDEF table which maps each of paired emojis to a certain class, is modified by the scripts. This is for the easiest backward-compatible solution for the emoji font. In this table, emojis with class 1 and 3 represent left and right, respectively. With those present, the text render engine on iOS 14+ will try to place the pair close together again even when we applied shift-multi.py to the font. Another script remove-class3.py ensures that there are no class 1 and 3 emojis that will otherwise be visible to the users.

remove-strikes.py removes supposedly least used strikes (image data) from sbix table. By default, emoji images come in a variety of dimensions from 20x20 to 160x160. If images are uncompressed (macOS, for example), the total font size exceeds 100 MB which is not suitable for storing in GitHub repository.

extractor.py extracts PNG emoji images from the font. This opens up the possibility to theme the emoji font.

Theming

Theming scripts for all emojis vendors produce the font in TTC format. The font may be used by EmojiFontManager iOS tweak, and is guaranteed to work on iOS 6 and higher. Ensure that you executed apple.sh before following instructions below.

Blobmoji Emoji

1. Clone blobmoji and place its folder alongside this project.
2. Execute blobmoji.sh to create themed font, output at blobmoji/blobmoji.ttc.

Facebook Emoji

1. Shallow clone emoji-data and place its folder alongside this project.
2. Execute facebook.sh to create them themed font, output at facebook/facebook.ttc.

FluentUI Emoji

1. Clone fluentui-emoji and place its folder alongside this project.
2. Execute fluentui.sh STYLE (where STYLE is one of this list: Color, Flat, High Contrast) to create themed font, output at fluentui/fluentui-STYLE.ttc.

Google Noto Emoji

1. Clone noto-emoji and place its folder alongside this project.
2. Execute noto-emoji.sh to create the themed font, output at noto-emoji/noto-emoji.ttc.

JoyPixels Emoji

1. Download JoyPixels 7.0 Free assets from JoyPixels Download page and place the folder alongside this project.
2. Execute joypixels.sh to create themed font, output at joypixels/joypixels.ttc.

OpenMoji Emoji

1. Clone openmoji and place its folder alongside this project.
2. Execute openmoji.sh to create themed font, output at openmoji/openmoji.ttc.

Samsung One UI Emoji

1. Retrieve NotoColorEmoji.ttf with Samsung One UI 5.0 emojis somehow and place that in oneui folder.
2. Execute oneui.sh to create themed font, output at oneui/oneui.ttc.

Twitter Twemoji

1. Clone twemoji and place its folder alongside this project.
2. Execute twemoji.sh to create the themed font, output at twemoji/twemoji.ttc.

WhatsApp Emoji

1. Retrieve NotoColorEmoji.ttf with WhatsApp emojis somehow and place that in whatsapp folder.
2. Execute whatsapp.sh to create themed font, output at whatsapp/whatsapp.ttc.