https://github.com/losketch/unicodefontset-magisk-module
A full Unicode font set Magisk module / 一个完整 Unicode 字体合集的 Magisk 模块
https://github.com/losketch/unicodefontset-magisk-module
emoji fallback font magisk-module unicode
Last synced: about 2 months ago
JSON representation
A full Unicode font set Magisk module / 一个完整 Unicode 字体合集的 Magisk 模块
- Host: GitHub
- URL: https://github.com/losketch/unicodefontset-magisk-module
- Owner: Losketch
- License: apache-2.0
- Created: 2025-05-10T11:37:25.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-09-11T05:37:35.000Z (8 months ago)
- Last Synced: 2025-09-11T08:53:45.742Z (8 months ago)
- Topics: emoji, fallback, font, magisk-module, unicode
- Language: Shell
- Homepage:
- Size: 7.58 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
- License: LICENSE
Awesome Lists containing this project
README
# Magisk Module: Extended Unicode Font Set (UFS-Magisk)
> **This module does not depend on system fonts. By combining multiple fonts, it provides complete glyph coverage for all characters currently defined in the Unicode 18.0 Alpha standard (excluding surrogate areas and the Private Use Areas).**
> **The module installs fonts and configuration incrementally so existing font modules remain intact.**
This module is designed for rooted Android devices and installs a comprehensive Unicode font set and configuration files via the Magisk framework.
This project takes inspiration from [simonsmh’s notocjk module](https://github.com/simonsmh/notocjk) and [lakejason0’s AAnother-Plangothic-magisk-module](https://github.com/lakejason0/AAnother-Plangothic-magisk-module) — using scripts to dynamically modify font configuration files.
## Overview
The core function of this module is to install multiple font files into the system font directory (/system/fonts) and dynamically update system fonts.xml and related configuration files so the system gains broad additional complete glyph coverage.
## Download
Please visit the [Releases page](https://github.com/Losketch/UnicodeFontSet-magisk-module/releases) to download the latest version.
## Notes and Usage
- **Compatibility**: This module may not be compatible with every device or highly customized ROM. For more compatibility information, refer to:
- [lxgw’s CJK font Magisk module compatibility notes](https://github.com/lxgw/advanced-cjk-font-magisk-module-template#兼容性调整-仅供参考)
- [simonsmh’s notocjk module](https://github.com/simonsmh/notocjk)
- **App crashes**: Android 12 and later introduced significant changes to font loading. Fonts are no longer preloaded during zygote initialization and are instead loaded on demand, which may cause compatibility issues with traditional Magisk font modules. If you encounter app crashes, please install the [FontLoader](https://github.com/RikkaW/FontLoader) module.
- If you already have other font Magisk modules installed, this module inserts its fonts and XML entries incrementally rather than overwriting existing font configurations, ensuring that the behavior of previously installed modules is preserved.
- **Installation order**:
- It is recommended to install other font modules first and reboot once, then install this font module and reboot again to ensure compatibility.
- If updates to other font modules later cause this module’s fonts not to take effect immediately, rebooting 1–2 times (or re‑enabling the Magisk module) should restore proper font rendering.
- **Font features**: This collection aims to maximize character coverage and rendering stability. It does **not** include or rely on ligatures or advanced shaping features. For color emoji fonts, please ensure that your system and applications support the COLRv1 format (Android 12L+ and modern browsers provide support).
- **Kernel managers (KernelSU, APatch)**:
- **KernelSU users**:
- ⚠️ A **meta module (e.g. `meta-overlayfs`) must be installed first**; otherwise, font files under `system/fonts/` will not be mounted correctly
- For more information, see the [KernelSU Metamodule documentation](https://kernelsu.org/guide/metamodule.html)
- It is recommended to disable KernelSU’s “auto uninstall modules” (or similar) feature to ensure fonts work properly
- **Hiding solutions**: If you use tools such as Shamiko, configure them in blacklist / denylist mode
- **Disclaimer**: This module is provided “as-is” for personal learning and educational purposes only. Users assume all risks. The author accepts no responsibility for any device issues that may arise from installing this module.
## Font Information
- 📄 [Font Sources and Licenses](docs/LICENSES.md)
- 🙏 [Acknowledgements](docs/CREDITS.md)
## Font Cache Cleaning Tool
### Function Description
The module includes a built-in `font-cmap-cleaner` tool for cleaning font cmap tables, which resolves the following issues:
- Abnormal display of kaomoji (such as ʕ•ᴥ•ʔ, (╯°□°）, ๑⃙⃘´༥`๑⃙⃘, (ͼ̤͂ ͜ ͽ̤͂)✧)
- Emoji showing as blank / squares / misaligned (like 😀.png, 🤓:nerd face)
### Usage
During installation, the module will prompt you whether to execute cmap cleaning:
- Press "Volume Up" to skip cleaning
- Press "Volume Down" to execute cleaning
- No operation for 15 seconds will automatically skip
### Notes
- This operation modifies font files in the module, but it is safe and reversible
- The cleaning process may take several minutes, please be patient
- You need to restart your device after cleaning to see the effect
## Frequently Asked Questions (FAQ)
### Q: What should I do if some apps crash after installation?
A: Android 12+ introduced changes to font loading mechanisms, which may cause compatibility issues with traditional Magisk font modules. Please install the [FontLoader](https://github.com/RikkaW/FontLoader) module to solve this issue.
### Q: What should I do if fonts don't change after installation?
A: Please try the following solutions:
1. Reboot your device 1-2 times
2. Re-enable the module
3. Check for conflicts with other font modules
4. View the module log at `${MODPATH:-/cache}/ufs.log` for detailed information
### Q: How to check if the module is working properly?
A: You can verify through the following methods:
1. Check if the module's font files exist in `/system/fonts` directory
2. Check if `/system/etc/fonts.xml` or `/system/product/etc/fonts.xml` contains UnicodeFontSetModule related configurations
3. Use a Unicode testing app to check if special characters display correctly
### Q: Which Android versions does the module support?
A: The module supports Android 8.0+ (API 26+).
## Troubleshooting
### View Module Logs
The module generates log files during operation, which you can view through the following methods:
- Log path: `${MODPATH:-/cache}/ufs.log`
- Use ADB command to view: `adb pull ${MODPATH:-/cache}/ufs.log`
### Clean Module Residues
If there are still issues after uninstalling the module, you can clean module residue files:
```bash
su -c rm -rf /data/adb/ufs_lock
su -c rm -rf /cache/ufs.log
```