https://github.com/luisgabrielroldan/chisel
A library to sculpt text on any device that you can handle pixels
https://github.com/luisgabrielroldan/chisel
bitmap-font lcd renderer text
Last synced: 3 months ago
JSON representation
A library to sculpt text on any device that you can handle pixels
- Host: GitHub
- URL: https://github.com/luisgabrielroldan/chisel
- Owner: luisgabrielroldan
- License: apache-2.0
- Created: 2019-11-28T16:58:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-12T00:32:52.000Z (almost 2 years ago)
- Last Synced: 2024-12-06T09:24:37.569Z (over 1 year ago)
- Topics: bitmap-font, lcd, renderer, text
- Language: Elixir
- Homepage:
- Size: 1.58 MB
- Stars: 45
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Chisel
[](https://github.com/luisgabrielroldan/chisel/commits/master)
[](https://hex.pm/packages/chisel)
[](https://hexdocs.pm/chisel)
Chisel is a library that uses bitmap fonts to sculpt text on any device that can handle pixels.
## Setup
Add Chisel to your mix.exs deps:
```elixir
{:chisel, "~> 0.2.0"},
```
Run `mix deps.get` to download the new dependency.
## Usage
1. Take a function to draw pixels...
```elixir
put_pixel = fn x, y ->
YourDisplay.draw_pixel(x, y, ...)
end
```
2. Pick a BDF font (Look for one on the Internet or take one from the fixtures folder on this project)
```elixir
{:ok, font} = Chisel.Font.load("foo/bar/font.bdf")
```
3. Use Chisel to sculpt the text using the provided function and font
```elixir
Chisel.Renderer.draw_text("Hello World!", x, y, font, put_pixel)
```
4. Enjoy!
(Thanks to [lawik](https://github.com/lawik) for the picture)
## General purpose
Chisel is a general purpose library that can be used to render text on any target based on pixels (LCD, Led matrixs, image files, ...).
### Render on an image with `:egd`
```elixir
img = :egd.create(200, 50)
color = :egd.color({0, 0, 0})
put_pixel = fn x, y ->
:egd.line(img, {x, y}, {x, y}, color)
end
{:ok, font} = Chisel.Font.load("font.bdf")
Chisel.Renderer.draw_text("Hello World!", 0, 0, font, put_pixel)
:egd.save(:egd.render(img, :png), "test.png")
```
### Render ASCII art
```elixir
put_pixel = fn x, y, pixels ->
[{x, y} | pixels]
end
{:ok, font} = Chisel.Font.load("c64.bdf")
{pixels, _, _} = Chisel.Renderer.reduce_draw_text("Hello World!", 0, 0, font, [], put_pixel)
for y <- 0..10 do
for x <- 0..100 do
if Enum.member?(pixels, {x, y}) do
"%"
else
" "
end
end
|> IO.puts()
end
```
Result:
```
%% %% %% %% %%
%% %% %%% %%% %% %% %%% %% %%
%% %% %%%% %% %% %%%% %% %% %%%% %%%%% %% %% %%
%%%%%% %% %% %% %% %% %% %% % %% %% %% %% %% %% %%%%% %%
%% %% %%%%%% %% %% %% %% %%%%%%% %% %% %% %% %% %%
%% %% %% %% %% %% %% %%% %%% %% %% %% %% %% %%
%% %% %%%% %%%% %%%% %%%% %% %% %%%% %% %%%% %%%%% %%
```
### Samples using [OLED](https://github.com/pappersverk/oled)
Using the right font it is even possible to render unicode strings.
Many good BDF fonts are available [here](https://github.com/olikraus/u8g2/tree/master/tools/font/bdf) on the [U8g2](https://github.com/olikraus/u8g2) library repo.
Check fonts licenses [here](https://github.com/olikraus/u8g2/wiki/fntgrp).