Files
glsl-glyphs/README.md
T
2026-11-07 15:55:15 +01:00

77 lines
2.4 KiB
Markdown

[![](https://git.klemek.fr/klemek/glsl-glyphs/actions/workflows/lint.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/glsl-glyphs/actions?workflow=lint.yml)
# GLSL Glyphs Generator
> Generate GLSL ready 8x8 glyph maps and usable functions
## Usage
```txt
usage: glsl-glyphs [-h] -i SOURCE_IMAGE_PATH [-n TARGET_NAME] -o TARGET_PATH [--glyph-names SOURCE_NAMES_PATH] [-s SOURCE_SETS_PATH]
[--functions | --no-functions] [--verbose | --no-verbose] [--quiet | --no-quiet]
options:
-h, --help show this help message and exit
-i, --input SOURCE_IMAGE_PATH
png 8x8 glyph map
-n, --name TARGET_NAME
target derived name for GLSL constants and functions (default: glyph)
-o, --output TARGET_PATH
output glsl file
--glyph-names SOURCE_NAMES_PATH
glyphs names, one line each
-s, --sets SOURCE_SETS_PATH
defined sets in CSV: index,length,name
--functions, --no-functions
add GLSL functions to output (default)
--verbose, --no-verbose
more verbose logging
--quiet, --no-quiet disable logging
```
## More info about included resources
### IBM PC CP437
See [Why is there a "small house" in IBM's Code page 437?](https://blog.glyphdrawing.club/why-is-there-a-small-house-in-ibm-s-code-page-437/) for more info on IBM PC CP437.
### Crystalwarrior
See [1 bit by Crystalwarrior](https://alex-noir.itch.io/1-bit-by-cw)
### Pmlomb
See [8x8 1 bit pixel set](https://opengameart.org/content/8x8-1-bit-pixel-set)
## Development
### Makefile
```txt
Usage: make [target1] [target2] ...
Commands/Targets:
help show this message
install install project
update update project dependencies
run run project
format format project
lint lint project
build build project
uv-sync uv sync
uv-upgrade uv sync upgrade
uv-run uv run (project)
ruff ruff check
ruff-fix ruff check (and fix)
ruff-format ruff format
ruff-format-check ruff format (check only)
ty ty check
release-% release major/minor/patch
```
### TODO
* [ ] Initial implementation
* [ ] Custom height glyph map
* [ ] Custom width glyph map