Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/presentkim-pm/unicodefontloader
Automatically load unicode font images and pack them into resourcepack!
https://github.com/presentkim-pm/unicodefontloader
Last synced: about 2 months ago
JSON representation
Automatically load unicode font images and pack them into resourcepack!
- Host: GitHub
- URL: https://github.com/presentkim-pm/unicodefontloader
- Owner: presentkim-pm
- License: lgpl-3.0
- Created: 2024-03-22T02:16:52.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-05T17:35:49.000Z (2 months ago)
- Last Synced: 2024-11-05T18:35:41.638Z (2 months ago)
- Language: PHP
- Homepage:
- Size: 37.1 KB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
![Version][version-badge]
[![Stars][stars-badge]][stars-url]
[![License][license-badge]][license-url]
UnicodeFontLoader
An plugin that automatically load unicode font images and pack them into resourcepack!
[Contact to me][author-discord] · [Report a bug][issues-url] · [Request a feature][issues-url]
## 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](https://wiki.bedrock.dev/concepts/emojis.html)
:heavy_check_mark: Automatically generates font resource pack based on character images (
like `resource_packs/font/glyph_XX/YY.png`).
:heavy_check_mark: Registers the generated resource pack on the server
:heavy_check_mark: Separates and applies existing font glyph files (`glyph_**.png`) on `resource_packs/` directory.
:heavy_check_mark: 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](https://wiki.bedrock.dev/concepts/emojis.html#hexValue)
or [unicodeconverter.net](https://unicodeconverter.net/).
> exmaple) When server directory is configured as below,
>
> ```bash
> . # 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.
>
> ```bash
> . # 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`](https://github.com/pmmp/PocketMine-MP/).
##
-----
## Downloads
### Download from [Github Releases][releases-url]
[![Github Downloads][release-badge]][releases-url]
##
-----
## 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][license-url] for more information
##
-----
[author-discord]: https://discordapp.com/users/345772340279508993
[poggit-ci-badge]: https://poggit.pmmp.io/ci.shield/presentkim-pm/UnicodeFontLoader/UnicodeFontLoader?style=for-the-badge
[poggit-version-badge]: https://poggit.pmmp.io/shield.api/UnicodeFontLoader?style=for-the-badge
[poggit-downloads-badge]: https://poggit.pmmp.io/shield.dl.total/UnicodeFontLoader?style=for-the-badge
[version-badge]: https://img.shields.io/github/v/release/presentkim-pm/UnicodeFontLoader?display_name=tag&style=for-the-badge&label=VERSION
[release-badge]: https://img.shields.io/github/downloads/presentkim-pm/UnicodeFontLoader/total?style=for-the-badge&label=GITHUB%20
[stars-badge]: https://img.shields.io/github/stars/presentkim-pm/UnicodeFontLoader.svg?style=for-the-badge
[license-badge]: https://img.shields.io/github/license/presentkim-pm/UnicodeFontLoader.svg?style=for-the-badge
[poggit-ci-url]: https://poggit.pmmp.io/ci/presentkim-pm/UnicodeFontLoader/UnicodeFontLoader
[poggit-release-url]: https://poggit.pmmp.io/p/UnicodeFontLoader
[stars-url]: https://github.com/presentkim-pm/UnicodeFontLoader/stargazers
[releases-url]: https://github.com/presentkim-pm/UnicodeFontLoader/releases
[issues-url]: https://github.com/presentkim-pm/UnicodeFontLoader/issues
[license-url]: https://github.com/presentkim-pm/UnicodeFontLoader/blob/main/LICENSE
[project-icon]: https://raw.githubusercontent.com/presentkim-pm/UnicodeFontLoader/main/assets/icon.png
[project-preview]: https://raw.githubusercontent.com/presentkim-pm/UnicodeFontLoader/main/assets/preview.gif