mirror of
https://github.com/nicbarker/clay.git
synced 2025-09-18 12:36:17 +00:00
89 lines
2.6 KiB
Markdown
89 lines
2.6 KiB
Markdown
# Termbox2 renderer demo
|
|
|
|
Terminal-based renderer using [termbox2](https://github.com/termbox/termbox2)
|
|
|
|
This demo shows a color palette and a few different components. It allows
|
|
changing configuration settings for colors, border size rounding mode,
|
|
characters used for borders, and transparency.
|
|
|
|
```
|
|
Keybinds:
|
|
c/C - Cycle through color modes
|
|
b/B - Cycle through border modes
|
|
h/H - Cycle through border characters
|
|
i/I - Cycle through image modes
|
|
t/T - Toggle transparency
|
|
d/D - Toggle debug mode
|
|
q/Q - Quit
|
|
```
|
|
|
|
Configuration can be also be overriden by environment variables:
|
|
- `CLAY_TB_COLOR_MODE`
|
|
- `NORMAL`
|
|
- `256`
|
|
- `216`
|
|
- `GRAYSCALE`
|
|
- `TRUECOLOR`
|
|
- `NOCOLOR`
|
|
- `CLAY_TB_BORDER_CHARS`
|
|
- `DEFAULT`
|
|
- `ASCII`
|
|
- `UNICODE`
|
|
- `NONE`
|
|
- `CLAY_TB_IMAGE_MODE`
|
|
- `DEFAULT`
|
|
- `PLACEHOLDER`
|
|
- `BG`
|
|
- `ASCII_FG`
|
|
- `ASCII`
|
|
- `UNICODE`
|
|
- `ASCII_FG_FAST`
|
|
- `ASCII_FAST`
|
|
- `UNICODE_FAST`
|
|
- `CLAY_TB_TRANSPARENCY`
|
|
- `1`
|
|
- `0`
|
|
- `CLAY_TB_CELL_PIXELS`
|
|
- `widthxheight`
|
|
|
|
## Building
|
|
|
|
Build the binary with cmake
|
|
|
|
```sh
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make
|
|
```
|
|
|
|
Then run the executable:
|
|
|
|
```sh
|
|
./clay_examples_termbox2_demo
|
|
```
|
|
|
|
## Attributions
|
|
|
|
Resources used:
|
|
- `512px-Shark_antwerp_zoo.jpeg`
|
|
- Retrieved from <https://commons.wikimedia.org/wiki/File:Shark_antwerp_zoo.jpg>
|
|
- License: [Creative Commons Attribution 3.0 Unported](https://creativecommons.org/licenses/by/3.0/)
|
|
- No changes made
|
|
- `512px-Balmoral_Castle_30_July_2011.jpg`
|
|
- Retrieved from <https://commons.wikimedia.org/wiki/File:Balmoral_Castle_30_July_2011.jpg>
|
|
- License: [Creative Commons Attribution-ShareAlike 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)
|
|
- No changes made
|
|
- `512px-German_Shepherd_(aka_Alsatian_and_Alsatian_Wolf_Dog),_Deutscher_Schäferhund_(Folder_(IV)_22.jpeg`
|
|
- Retrieved from <https://commons.wikimedia.org/wiki/File:German_Shepherd_(aka_Alsatian_and_Alsatian_Wolf_Dog),_Deutscher_Sch%C3%A4ferhund_(Folder_(IV)_22.JPG>
|
|
- License: [Creative Commons Attribution-ShareAlike 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)
|
|
- No changes made
|
|
- `512px-Rosa_Cubana_2018-09-21_1610.jpeg`
|
|
- Retrieved from <https://commons.wikimedia.org/wiki/File:Rosa_Cubana_2018-09-21_1610.jpg>
|
|
- License: [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/)
|
|
- No changes made
|
|
- `512px-Vorderer_Graben_10_Bamberg_20190830_001.jpeg`
|
|
- Retrieved from <https://commons.wikimedia.org/wiki/File:Vorderer_Graben_10_Bamberg_20190830_001.jpg>
|
|
- License: [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/)
|
|
- No changes made
|