From 1705ab13f32675e0aed2906a023565514ad163ff Mon Sep 17 00:00:00 2001 From: HappiePlant Date: Fri, 23 Aug 2024 22:31:25 +0200 Subject: [PATCH] Create a README --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c39bffa..ea12ca3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Minecraft Seven Builder -Tool to build the minecraft font files into a format for [Pixel Font Converter](https://yellowafterlife.itch.io/pixelfont) \ No newline at end of file +Tool to build the minecraft font files into a format for [Pixel Font Converter](https://yellowafterlife.itch.io/pixelfont) + +This project aims to be 100% faithful to the original Minecraft font by providing all glyphs and correct spacing. + +## Build steps +### Using [`uv`](https://docs.astral.sh/uv/) + +1. Clone this repo +2. Run `uv run src/minecraft_seven/__init__.py` +3. Open [Pixel Font Converter](https://yal.cc/r/20/pixelfont/) +4. Click `Menu` in the top right and select `Batch process` +5. Navigate to the `out` folder in this repo and select both the `png` and `json` file. (by holding Ctrl) +6. Install the ttf in the downloaded zip! + +## Known issues +- The font doesn't look right when used in LibreSprite + +## Planned features +- [x] Build the Minecraft font files into a format for Pixel Font Converter +- [ ] Options for generating the enchanting table or illager font. \ No newline at end of file