EmojiFonts

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

Prerequisites

• Bash version 5+ (brew install bash)
• Python 3.7+
• pip
• fonttools 4.48.0+ (pip3 install fonttools[repacker]>=4.48.0)
• afdko (pip3 install afdko)
• libpylzfse (pip3 install libpylzfse)
• Pillow (pip3 install Pillow)
• pngquant (brew install pngquant)
• oxipng (brew install oxipng)

Prerequisites (Theming)

• ImageMagick (brew install freetype imagemagick)
• librsvg (brew install librsvg)
• svgo (brew install svgo)

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. Execute ./prepare.sh to create emoji TTF files and tables. Run this once.

Building Apple Color Emoji font

Build format: ./apple-prepare.sh <OS> && ./apple.sh [HD]

Replace <OS> with macOS (if you have both macOS and iOS fonts) or iOS (if you only have iOS font).

Replace [HD] with HD if you want to build HD version (160x160 image set included), or leave it blank for normal version.

Executing ./apple-prepare.sh <OS> && ./apple.sh will get [email protected] (for iOS 10 and above) and [email protected] (for iOS 9 and below) for you under apple directory.

Notable Python Scripts

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.

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

PNG Optimization

pngquant and oxipng are used to optimize the images with little to none changes to the quality. The Apple emoji font sizes are reduced by 50% using this method. The simpler the emoji images, the more size reduction is achieved.

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-prepare.sh <OS> && ./apple.sh HD before following instructions below.

It is recommended to limit the depth of clone to 1 (git clone --depth 1 REPO-URL) because the repository size is usually big.

Blobmoji Emoji

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

Facebook Emoji

1. Clone facebook-emojis and place its folder alongside this project.
2. Execute cd facebook && ./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 cd fluentui && ./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 Color Emoji

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

JoyPixels Emoji

1. Clone emoji-assets and place its folder alongside this project.
2. Execute cd joypixels && ./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 cd openmoji && ./openmoji.sh to create themed font, output at openmoji/openmoji.ttc.

Samsung One UI Emoji

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

Toss Face Emoji

1. Download TossFaceFontMac.ttf from tossface GitHub Releases and place that in tossface folder.
2. Execute cd tossface && ./tossface.sh to create themed font, output at tossface/tossface.ttc.

Twitter Twemoji

1. Clone twemoji and place its folder alongside this project.
2. Execute cd twemoji && ./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 cd whatsapp && ./whatsapp.sh to create themed font, output at whatsapp/whatsapp.ttc.