mirror of
https://codeberg.org/scip/kageviewer.git
synced 2025-12-16 20:20:58 +01:00
142 lines
4.8 KiB
Markdown
142 lines
4.8 KiB
Markdown
# kageviewer - Viewer for shaders written in Kage, similar to glslviewer
|
|
|
|
|
|
|
|
[](https://codeberg.org/scip/kageviewer/raw/branch/main/LICENSE)
|
|
[](https://goreportcard.com/report/codeberg.org/scip/kageviewer)
|
|
[](https://ci.codeberg.org/repos/15617)
|
|
|
|
This little tool can be used to test shaders written in
|
|
[Kage](https://ebitengine.org/en/documents/shader.html), a shader meta
|
|
language for
|
|
[Ebitengine](https://github.com/hajimehoshi/ebiten). kageviewer
|
|
reloads changed assets, which allows you to develop your shader and
|
|
see live, how it responds to your changes. If loading fails, an error
|
|
will be printed to STDOUT. The same applies for images.
|
|
|
|
## Screenshot
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Since `kageviewer` is primarily aimed at golang game developers, no
|
|
pre built binaries are provided.
|
|
|
|
### Installation with go
|
|
|
|
```shell
|
|
go install codeberg.org/scip/kageviewer@latest
|
|
```
|
|
|
|
### Installation from source
|
|
|
|
You will need the Golang toolchain in order to build from source. GNU
|
|
Make will also help but is not strictly neccessary.
|
|
|
|
If you want to compile the tool yourself, use `git clone` to clone the
|
|
repository. Then execute `go mod tidy` to install all
|
|
dependencies. Then just enter `go build` or - if you have GNU Make
|
|
installed - `make`.
|
|
|
|
To install after building either copy the binary or execute `sudo make
|
|
install`.
|
|
|
|
# Usage
|
|
|
|
```shell
|
|
kageviewer -h
|
|
This is kageviewer, a shader viewer.
|
|
|
|
Usage: kageviewer [-vd] [-c <config file>] [-g geom] [-p geom] \
|
|
-i <image0.png> -i <image1.png> -s <shader.kage>
|
|
|
|
Options:
|
|
-c --config <toml file> Config file to use (optional)
|
|
-i --image <png file> Image to load (multiple times allowed, up to 4)
|
|
-s --shader <kage file> Shader to run
|
|
-g --geometry <WIDTHxHEIGHT> Window size
|
|
-p --position <XxY> Position of image0
|
|
-b --background <png file> Image to load as background
|
|
-t --tps <ticks/s> At how many ticks per second to run
|
|
--map-flag <name> Map Flag uniform to <name>
|
|
--map-ticks <name> Map Ticks uniform to <name>
|
|
--map-time <name> Map Time uniform to <name>
|
|
--map-slider <name> Map Slider uniform to <name>
|
|
--map-mouse <name> Map Mouse uniform to <name>
|
|
-d --debug Show debugging output
|
|
-v --version Show program version
|
|
```
|
|
|
|
Example usage using the provided example:
|
|
|
|
```shell
|
|
kageviewer -g 32x32 -i example/wall.png -i example/damage.png -s example/destruct.kg
|
|
```
|
|
|
|
Hit `SPACE` or press the left mouse button to toggle the damage
|
|
mask. Press the `UP` or `DOWN` key to adjust the damage scale.
|
|
|
|
# Uniforms
|
|
|
|
Since this is a generic viewer, you cannot (yet) use custom
|
|
uniforms. If you need this, just edit the source accordingly.
|
|
|
|
Uniforms supported so far:
|
|
|
|
- `var Flag int`: a flag which toggles between 0 and 1 by pressing
|
|
`SPACE` or pusing the left mouse button
|
|
- `var Slider float`: a normalized float value, you can increment it
|
|
with `UP` or `DOWN`
|
|
- `var Time float`: the time the game runs (ticks / TPS)
|
|
- `var Ticks float`: the number of updates happened so far
|
|
- `var Mouse vec2`: the current mouse position
|
|
|
|
If you want to test an existing shader and don't want to rename the
|
|
uniforms, you can map the ones provided by **kageviewer** to custom
|
|
names using the `--map-*` options. For example:
|
|
|
|
```shell
|
|
kageviewer -g 640x480 --map-ticks Time --map-mouse Cursor examples/shader/default.go
|
|
```
|
|
|
|
This executes the example shader in the ebitenging source repository.
|
|
|
|
# Config File
|
|
|
|
You can use a config file to store your own codes, once you found one
|
|
you like. A configfile is searched in these locations in this order:
|
|
|
|
* `/etc/kageviewer.conf`
|
|
* `/usr/local/etc/kageviewer.conf`
|
|
* `$HOME/.config/kageviewer/config`
|
|
* `$HOME/.kageviewer`
|
|
|
|
You may also specify a config file on the commandline using the `-c`
|
|
flag.
|
|
|
|
Config files are expected to be in the [TOML format](https://toml.io/en/).
|
|
|
|
Possible parameters equal the long command line options.
|
|
|
|
# TODO
|
|
|
|
- [X] Implement loading of images and shader files
|
|
- [X] Implement basic shader rendering and user input
|
|
- [ ] Add custom uniforms (maybe using lua code?)
|
|
- [x] Provide a way to respond live to shader code changes (use lua as
|
|
well?)
|
|
|
|
# Report bugs
|
|
|
|
[Please open an issue](https://codeberg.org/scip/kageviewer/issues). Thanks!
|
|
|
|
# License
|
|
|
|
This work is licensed under the terms of the General Public Licens
|
|
version 3.
|
|
|
|
# Author
|
|
|
|
Copyleft (c) 2024 Thomas von Dein
|