# BDF2MCPack
BDF2MCPack is a CLI application to convert a BDF type font file to a resource
pack for Minecraft.
The application requires Python 3.7 or above.
## Installation
### Windows, Linux and MacOS
Use [pip](https://pip.pypa.io/en/stable/installation/) to install the module.
```sh
pip install bdf2mcpack
```
Make sure that the executable file (`bdf2mcpack.exe` or `bdf2mcpack`) is
installed under a directory which is set in the `PATH` environment variable.
## Usage
### Help Message
```
usage: bdf2mcpack [-h] [-o output] [--format FORMAT] [--description DESCRIPTION]
[--compresslevel {0,1,2,3,4,5,6,7,8,9}] [--range [RANGE ...]]
input
Creates a resource pack for Minecraftfrom a BDF type file.
positional arguments:
input The filename of the BDF file to load
options:
-h, --help show this help message and exit
-o output The Filename of the resource pack to create (default:
pack.zip)
--format FORMAT, -f FORMAT
The value to set as pack.pack_format in pack.mcmeta
(default: 18)
--description DESCRIPTION, -d DESCRIPTION
The text to set as pack.description in pack.mcmeta
(default: "Generated by bdf2mcpack")
--compresslevel {0,1,2,3,4,5,6,7,8,9}, -c {0,1,2,3,4,5,6,7,8,9}
The compression level used when writing the output file
(default: 6)
--range [RANGE ...], -r [RANGE ...]
The Unicode codepoint range to use. Accepts decimal or
hexadecimal expressions of codepoints. Case insensitive.
e.g. 0-127 U+100000-U+10FFFF
```
### Example
This example downloads [Unifont](https://unifoundry.com/unifont/index.html)
Japanese BDF Version, and creates a resource pack to replace ideographic
Chinese Characters with Japanese Kanji.
```sh
curl -O https://unifoundry.com/pub/unifont/unifont-15.1.04/font-builds/unifont_jp-15.1.04.bdf.gz
gunzip unifont_jp-15.1.04.bdf.gz
bdf2mcpack unifont_jp-15.1.04.bdf -o kanji.zip -r U+4E00-U+9FFF
```
## Used Libraries
* [bdfparser](https://github.com/tomchen/bdfparser)
* [Pillow](https://github.com/python-pillow/Pillow)
* [tqdm](https://github.com/tqdm/tqdm)
## License
This program is distributed under Apache-2.0 license.
Raw data
{
"_id": null,
"home_page": "https://github.com/takejohn/BDF2MCPack",
"name": "bdf2mcpack",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "minecraft bdf",
"author": "Take-John",
"author_email": "105504345+takejohn@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/7c/e5/2440f28c789865af777e6e1cba858465411a5d183974cc79030a51e56203/bdf2mcpack-0.1.1.tar.gz",
"platform": null,
"description": "# BDF2MCPack\n\nBDF2MCPack is a CLI application to convert a BDF type font file to a resource\npack for Minecraft. \nThe application requires Python 3.7 or above.\n\n## Installation\n\n### Windows, Linux and MacOS\n\nUse [pip](https://pip.pypa.io/en/stable/installation/) to install the module.\n```sh\npip install bdf2mcpack\n```\n\nMake sure that the executable file (`bdf2mcpack.exe` or `bdf2mcpack`) is\ninstalled under a directory which is set in the `PATH` environment variable.\n\n## Usage\n\n### Help Message\n```\nusage: bdf2mcpack [-h] [-o output] [--format FORMAT] [--description DESCRIPTION]\n [--compresslevel {0,1,2,3,4,5,6,7,8,9}] [--range [RANGE ...]]\n input\n\nCreates a resource pack for Minecraftfrom a BDF type file.\n\npositional arguments:\n input The filename of the BDF file to load\n\noptions:\n -h, --help show this help message and exit\n -o output The Filename of the resource pack to create (default:\n pack.zip)\n --format FORMAT, -f FORMAT\n The value to set as pack.pack_format in pack.mcmeta\n (default: 18)\n --description DESCRIPTION, -d DESCRIPTION\n The text to set as pack.description in pack.mcmeta\n (default: \"Generated by bdf2mcpack\")\n --compresslevel {0,1,2,3,4,5,6,7,8,9}, -c {0,1,2,3,4,5,6,7,8,9}\n The compression level used when writing the output file\n (default: 6)\n --range [RANGE ...], -r [RANGE ...]\n The Unicode codepoint range to use. Accepts decimal or\n hexadecimal expressions of codepoints. Case insensitive.\n e.g. 0-127 U+100000-U+10FFFF\n```\n\n### Example\n\nThis example downloads [Unifont](https://unifoundry.com/unifont/index.html)\nJapanese BDF Version, and creates a resource pack to replace ideographic\nChinese Characters with Japanese Kanji.\n```sh\ncurl -O https://unifoundry.com/pub/unifont/unifont-15.1.04/font-builds/unifont_jp-15.1.04.bdf.gz\ngunzip unifont_jp-15.1.04.bdf.gz\nbdf2mcpack unifont_jp-15.1.04.bdf -o kanji.zip -r U+4E00-U+9FFF\n```\n\n## Used Libraries\n\n* [bdfparser](https://github.com/tomchen/bdfparser)\n* [Pillow](https://github.com/python-pillow/Pillow)\n* [tqdm](https://github.com/tqdm/tqdm)\n\n## License\n\nThis program is distributed under Apache-2.0 license. \n",
"bugtrack_url": null,
"license": "",
"summary": "Creates a resource pack for Minecraft from a BDF type file",
"version": "0.1.1",
"project_urls": {
"Bug Reports": "https://github.com/takejohn/BDF2MCPack/issues",
"Homepage": "https://github.com/takejohn/BDF2MCPack",
"Source": "https://github.com/takejohn/BDF2MCPack"
},
"split_keywords": [
"minecraft",
"bdf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6cfe193124fc95828f1db18752439d61bac4449dfba3e401e0496360657969e2",
"md5": "87437f94b47c8c29eb70403181ce32bd",
"sha256": "552c850cb8cd2b14fa7c39053390af9249127522ed91f599e94753baaa4de0dd"
},
"downloads": -1,
"filename": "bdf2mcpack-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87437f94b47c8c29eb70403181ce32bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10018,
"upload_time": "2023-12-16T15:09:13",
"upload_time_iso_8601": "2023-12-16T15:09:13.138732Z",
"url": "https://files.pythonhosted.org/packages/6c/fe/193124fc95828f1db18752439d61bac4449dfba3e401e0496360657969e2/bdf2mcpack-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ce52440f28c789865af777e6e1cba858465411a5d183974cc79030a51e56203",
"md5": "a619f20fb391fe92a2f3d4a6902ef3bc",
"sha256": "640ca3c1f7683bf06e7c2a2edda7b0d91a5019325220d23181f262e476349fc8"
},
"downloads": -1,
"filename": "bdf2mcpack-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a619f20fb391fe92a2f3d4a6902ef3bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12279,
"upload_time": "2023-12-16T15:09:14",
"upload_time_iso_8601": "2023-12-16T15:09:14.920544Z",
"url": "https://files.pythonhosted.org/packages/7c/e5/2440f28c789865af777e6e1cba858465411a5d183974cc79030a51e56203/bdf2mcpack-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-16 15:09:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "takejohn",
"github_project": "BDF2MCPack",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bdf2mcpack"
}
JSON
