/UnicodeFontLoader

Automatically load unicode font images and pack them into resourcepack!

Primary LanguagePHPGNU Lesser General Public License v3.0LGPL-3.0

Version Stars License


Logo

UnicodeFontLoader

An plugin that automatically load unicode font images and pack them into resourcepack!

Contact to me · Report a bug · Request a feature

About The Project

Ever felt bothered managing emoji fonts for the server? Or struggled finding emoji Unicode? Try this plugin!

This plugin automatically bundles font files located in the resource_packs/font directory into a resourcepack.

For detailed information about image fonts, please visit bedrock.dev/concepts/emojis

✔️ Automatically generates font resource pack based on character images ( like resource_packs/font/glyph_XX/YY.png).
✔️ Registers the generated resource pack on the server
✔️ Separates and applies existing font glyph files (glyph_**.png) on resource_packs/ directory.
✔️ All results are cached to optimize repetitive tasks

Usage

  1. When you apply the plugin and start the server, the default unicode font images are generated as examples in the resource_packs/font directory.
  2. If a file named font/glyph_XX/YY.png exists, it will automatically be applied as the font corresponding to Unicode U+XXYY.
  3. If you want to convert existing font files to fit the plugin, simply place the 'glyph_XX.png' file in the 'font' directory, and it will be automatically converted.

The automatic conversion and build feature runs once when the server starts up. Restart is required for the changes to take effect after modification.

When using this image font on the server, simply input the corresponding character for 'U+XXYY' as usual.
The Unicode converter can be conveniently accessed via bedrock.dev or unicodeconverter.net.

exmaple) When server directory is configured as below,

. # pmmp directory
├── resource_packs
│   └── font
|       ├── glyph_E0
|       |   ├──── 01.png
|       |   ├──── 0A.png
|       |   └──── ...
|       |
│       └──── glyph_E3.png
│
└── ...

In that case, the 'glyph_E3.png' file will automatically be split into 'glyph_E3/YY.png' and applied to the server.
Additionally, the existing 'glyph_E3.png' file will be removed.

. # pmmp directory
├── resource_packs
│   └── font
|       ├── glyph_E0
|       |   ├──── 01.png
|       |   ├──── 0A.png
|       |   └──── ...
|       |
│       └─── glyph_E3
|       |   ├──── 0A.png
|       |   ├──── 0B.png
|       |   └──── ...
│
└── ...

TODO:

  • Supports linking resource pack to cdn urls
  • Create an html or markdown page that lists the registered image glyphs and provides a copy button.
  • Support for commands that register a unique name for each image font and make it available on chat

Target software:

This plugin officially only works with Pocketmine-MP.

Downloads

Download from Github Releases

Github Downloads

Installation

  1. Download plugin .phar releases
  2. Move downloaded .phar file to server's /plugins/ folder
  3. Restart the server

License

Distributed under the LGPL 3.0. See LICENSE for more information