From 739b03425b5bf86ba904d3d43ea79aee0722ff5b Mon Sep 17 00:00:00 2001 From: 0xMAC <55045978+0xMAC8205@users.noreply.github.com> Date: Wed, 1 Nov 2023 02:22:30 +0100 Subject: [PATCH] Update README.md --- README.md | 47 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d6bec94..c89157d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,36 @@ A Character ROM Editor for the LS7 Computer, written in Python 3 ![alt text](https://github.com/0xMAC8205/Character-Bitmap-Editor/assets/55045978/413ec10d-cec2-4d39-969c-e04246f455e8) Being written in Python, this editor is multi-platform. -It's based on this program: https://www.min.at/prinz/o/software/pixelfont +It's inspired by this program: https://www.min.at/prinz/o/software/pixelfont, +since it's only available on Windows :( + +# Exporting +The Program supports, exporting to an Assambler Include +(for the people whom may desire), +a C byte array or just a raw binary file (recommended). + +The Converted binary file, will be 2k or 4k in size +(Depending on, if 8x8 or 8x16 mode is used) + +# Customisation + +You can customise the Editor. For example the +Draw Field size, Displaying a Grid, Allowing Cursor Dragging + +You can configure your color theme in ($*RUNPATH*)/assets/settings/theme.txt, +or inject your custom add-ons. +(These changes only apply when opening another instance / restarting) + +# Interfacing + +**Matrix**: + +You Select the Character to modify, just by clicking the Box or you can cursor around the matrix. +Here => Settings "Cursor Wrapping" might be helpfull + +**Draw Field**: + +You can hold the mousebutton and drag the cursor to draw (depending if Cursor Draw is enabled) # .bmf file type '.bmf' literally stands for 'Bit Map File'. @@ -14,20 +43,12 @@ It holds the drawn characterset as raw bytes. Different from the "Raw Bytes" output file, by having a small info header at the start, -but almost identical. - -# Exporting -The Program supports, exporting to an Assambler Include -(for the people whom may desire), -a C byte array or just a raw binary file. - -The Converted binary file, will be 2k or 4k in size -(Depending on, if 8x8 or 8x16 mode is used) +but almost identical. (But **Not** Compatible) # Dependencies -> python3 - -> tkinter +* python3 +* tkinter +* functools # Known issues * Drawn content getting applied, when exiting current cell