Changes:

- renamed to kageviewer to match with repository name
- automatically determine shader size when needed
- added Time uniform
- don't provide binary releases anymore

.gitignore

@@ -1,2 +1,2 @@
 releases
-kage-viewer
+kageviewer

Makefile

@@ -16,7 +16,7 @@
 
 #
 # no need to modify anything below
-tool      = kage-viewer
+tool      = kageviewer
 VERSION   = $(shell grep VERSION config.go | head -1 | cut -d '"' -f2)
 archs     = darwin freebsd linux windows
 PREFIX    = /usr/local
@@ -44,7 +44,7 @@ shader-destruct: buildlocal
 	./$(tool) -g 32x32 -i example/wall.png -i example/damage.png --map-ticks Time -s example/destruct.kage
 
 shader-ebiten: buildlocal
-	./$(tool) -g 640x480 --map-ticks Time --map-mouse Cursor -s example/ebiten.kage
+	./$(tool) -g 640x480 --map-mouse Cursor -s example/ebiten.kage
 
 test: clean
 	mkdir -p t/out
@@ -75,12 +75,12 @@ goupdate:
 buildall:
 	./mkrel.sh $(tool) $(VERSION)
 
-release: buildall
+release:
 	gh release create v$(VERSION) --generate-notes releases/*
 
 show-versions: buildlocal
-	@echo "### kage-viewer version:"
+	@echo "### kageviewer version:"
-	@./kage-viewer -V
+	@./kageviewer -V
 
 	@echo
 	@echo "### go module versions:"

README.md

@@ -1,41 +1,31 @@
-# kage-viewer - Viewer for shaders written in Kage, similar to glslviewer
+# kageviewer - Viewer for shaders written in Kage, similar to glslviewer
 
-[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/tlinden/kage-viewer/blob/master/LICENSE)
+![Logo](https://github.com/TLINDEN/kageviewer/blob/main/.github/assets/logo.png)
-[![Go Report Card](https://goreportcard.com/badge/github.com/tlinden/kage-viewer)](https://goreportcard.com/report/github.com/tlinden/kage-viewer) 
 
-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).
+[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/tlinden/kageviewer/blob/master/LICENSE)
+[![Go Report Card](https://goreportcard.com/badge/github.com/tlinden/kageviewer)](https://goreportcard.com/report/github.com/tlinden/kageviewer) 
+
+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
+
+![Screenshot](https://github.com/TLINDEN/kageviewer/blob/main/.github/assets/screenshot.png)
 
 ## Installation
 
-The tool does not have any dependencies.  Just download the binary for
+Since `kageviewer` is primarily aimed at golang game developers, no
-your platform from the releases page and you're good to go.
+pre built binaries are provided.
 
-### Installation using a pre-compiled binary
+### Installation with go
-
-Go to the [latest release page](https://github.com/TLINDEN/kage-viewer/releases/latest)
-and look for your OS and platform. There are two options to install the binary:
-
-Directly     download     the     binary    for     your     platform,
-e.g. `kage-viewer-linux-amd64-0.0.2`, rename it to `kage-viewer` (or whatever
-you like more!)  and put it into  your bin dir (e.g. `$HOME/bin` or as
-root to `/usr/local/bin`).
-
-Be sure  to verify  the signature  of the binary  file. For  this also
-download the matching `kage-viewer-linux-amd64-0.0.2.sha256` file and:
 
 ```shell
-cat kage-viewer-linux-amd64-0.0.2.sha25 && sha256sum kage-viewer-linux-amd64-0.0.2
+go install github.com/tlinden/kageviewer@latest
-```
-You should see the same SHA256 hash.
-
-You  may  also download  a  binary  tarball  for your  platform,  e.g.
-`kage-viewer-linux-amd64-0.0.2.tar.gz`,  unpack and  install it.  GNU Make  is
-required for this:
-   
-```shell
-tar xvfz kage-viewer-linux-amd64-0.0.2.tar.gz
-cd kage-viewer-linux-amd64-0.0.2
-sudo make install
 ```
 
 ### Installation from source
@@ -54,10 +44,10 @@ install`.
 # Usage
 
 ```shell
-kage-viewer -h
+kageviewer -h
-This is kage-viewer, a shader viewer.
+This is kageviewer, a shader viewer.
 
-Usage: kage-viewer [-vd] [-c <config file>] [-g geom] [-p geom] \
+Usage: kageviewer [-vd] [-c <config file>] [-g geom] [-p geom] \
        -i <image0.png> -i <image1.png> -s <shader.kage>
 
 Options:
@@ -66,10 +56,13 @@ Options:
 -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 Flag uniform to <name>
+   --map-ticks  <name>          Map Ticks uniform to <name>
-   --map-slider <name>          Map Flag uniform to <name>
+   --map-time   <name>          Map Time uniform to <name>
-   --map-mouse  <name>          Map Flag 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
 ```
@@ -77,7 +70,7 @@ Options:
 Example usage using the provided example:
 
 ```shell
-kage-viewer -g 32x32 -i example/wall.png -i example/damage.png  -s example/destruct.kg
+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
@@ -94,15 +87,16 @@ Uniforms supported so far:
   `SPACE` or pusing the left mouse button
 - `var Slider float`: a normalized float value, you can increment it
   with `UP` or `DOWN`
-- `var Ticks float`: the time the game runs (ticks, not seconds!)
+- `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 **kage-viewer** to custom
+uniforms, you can map the ones provided by **kageviewer** to custom
 names using the `--map-*` options. For example:
 
 ```shell
-kage-viewer -g 640x480 --map-ticks Time --map-mouse Cursor examples/shader/default.go
+kageviewer -g 640x480 --map-ticks Time --map-mouse Cursor examples/shader/default.go
 ```
 
 This executes the example shader in the ebitenging source repository.
@@ -112,10 +106,10 @@ This executes the example shader in the ebitenging source repository.
 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/kage-viewer.conf`
+* `/etc/kageviewer.conf`
-* `/usr/local/etc/kage-viewer.conf`
+* `/usr/local/etc/kageviewer.conf`
-* `$HOME/.config/kage-viewer/config`
+* `$HOME/.config/kageviewer/config`
-* `$HOME/.kage-viewer`
+* `$HOME/.kageviewer`
 
 You may also specify a config file on the commandline using the `-c`
 flag.
@@ -129,12 +123,12 @@ Possible parameters equal the long command line options.
 - [X] Implement loading of images and shader files
 - [X] Implement basic shader rendering and user input
 - [ ] Add custom uniforms (maybe using lua code?)
-- [ ] Provide a way to respond live to shader code changes (use lua as
+- [x] Provide a way to respond live to shader code changes (use lua as
   well?)
 
 # Report bugs
 
-[Please open an issue](https://github.com/TLINDEN/kage-viewer/issues). Thanks!
+[Please open an issue](https://github.com/TLINDEN/kageviewer/issues). Thanks!
 
 # License
 

config.go

@@ -32,10 +32,10 @@ import (
 )
 
 const (
-	VERSION string = "0.0.2"
+	VERSION string = "0.0.5"
-	Usage   string = `This is kage-viewer, a shader viewer.
+	Usage   string = `This is kageviewer, a shader viewer.
 
-Usage: kage-viewer [-vd] [-c <config file>] [-g geom] [-p geom] \
+Usage: kageviewer [-vd] [-c <config file>] [-g geom] [-p geom] \
        -i <image0.png> -i <image1.png> -s <shader.kage>
 
 Options:
@@ -44,27 +44,33 @@ Options:
 -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 Flag uniform to <name>
+   --map-ticks  <name>          Map Ticks uniform to <name>
-   --map-slider <name>          Map Flag uniform to <name>
+   --map-time   <name>          Map Time uniform to <name>
-   --map-mouse  <name>          Map Flag 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
 `
 )
 
 type Config struct {
-	Showversion bool     `koanf:"version"`  // -v
+	Showversion bool     `koanf:"version"`    // -v
-	Debug       bool     `koanf:"debug"`    // -d
+	Debug       bool     `koanf:"debug"`      // -d
-	Config      string   `koanf:"config"`   // -c
+	Config      string   `koanf:"config"`     // -c
-	Image       []string `koanf:"image"`    // -i
+	Image       []string `koanf:"image"`      // -i
-	Shader      string   `koanf:"shader"`   // -s
+	Shader      string   `koanf:"shader"`     // -s
-	Geo         string   `koanf:"geometry"` // -g
+	Background  string   `koanf:"background"` // -b
-	Posision    string   `koanf:"position"` // -p
+	TPS         int      `koanf:"tps"`        // -t
+	Geo         string   `koanf:"geometry"`   // -g
+	Posision    string   `koanf:"position"`   // -p
 	Flag        string   `koanf:"map-flag"`
 	Ticks       string   `koanf:"map-ticks"`
 	Mouse       string   `koanf:"map-mouse"`
 	Slider      string   `koanf:"map-slider"`
+	Time        string   `koanf:"map-time"`
 
 	X, Y, Width, Height int // feed from -g + -p
 }
@@ -89,8 +95,11 @@ func InitConfig() (*Config, error) {
 	flagset.StringP("shader", "s", "", "shader file")
 	flagset.StringP("map-flag", "", "Flag", "map flag uniform")
 	flagset.StringP("map-ticks", "", "Ticks", "map ticks uniform")
+	flagset.StringP("map-time", "", "Time", "map time uniform")
 	flagset.StringP("map-mouse", "", "Mouse", "map mouse uniform")
 	flagset.StringP("map-slider", "", "Slider", "map slider uniform")
+	flagset.StringP("background", "b", "", "background image")
+	flagset.IntP("tps", "t", 60, "ticks per second")
 
 	if err := flagset.Parse(os.Args[1:]); err != nil {
 		return nil, fmt.Errorf("failed to parse program arguments: %w", err)
@@ -107,10 +116,10 @@ func InitConfig() (*Config, error) {
 		configfiles = []string{configfile}
 	} else {
 		configfiles = []string{
-			"/etc/kage-viewer.conf", "/usr/local/etc/kage-viewer.conf", // unix variants
+			"/etc/kageviewer.conf", "/usr/local/etc/kageviewer.conf", // unix variants
-			filepath.Join(home, ".config", "kage-viewer", "config"),
+			filepath.Join(home, ".config", "kageviewer", "config"),
-			filepath.Join(home, ".kage-viewer"),
+			filepath.Join(home, ".kageviewer"),
-			"kage-viewer.conf",
+			"kageviewer.conf",
 		}
 	}
 

game.go

@@ -24,17 +24,21 @@ import (
 	"log/slog"
 	"os"
 
+	"github.com/Zyko0/Ebiary/asset"
 	"github.com/hajimehoshi/ebiten/v2"
 	"github.com/hajimehoshi/ebiten/v2/inpututil"
 )
 
 type Game struct {
-	Conf   *Config
+	Conf         *Config
-	Images []*ebiten.Image
+	Images       []*asset.LiveAsset[*ebiten.Image]
-	Shader *ebiten.Shader
+	Shader       *asset.LiveAsset[*ebiten.Shader]
-	Ticks  int
+	ShaderBounds image.Rectangle
-	Slider float64
+	Cursor       []float64
-	Flag   int
+	Ticks        float64
+	Slider       float64
+	Flag         int
+	Background   *asset.LiveAsset[*ebiten.Image]
 }
 
 func LoadImage(name string) (*ebiten.Image, error) {
@@ -53,28 +57,62 @@ func LoadImage(name string) (*ebiten.Image, error) {
 }
 
 func (game *Game) Init() error {
+	// preload images
 	for _, image := range game.Conf.Image {
 		slog.Debug("Loading images", "image", image)
-		img, err := LoadImage(image)
+		//img, err := LoadImage(image)
+		img, err := asset.NewLiveAsset[*ebiten.Image](image)
 		if err != nil {
-			return err
+			return fmt.Errorf("failed to load image %s: %s", image, err)
 		}
 
 		game.Images = append(game.Images, img)
 	}
 
-	data, err := os.ReadFile(game.Conf.Shader)
+	// preload shader
+	shader, err := asset.NewLiveAsset[*ebiten.Shader](game.Conf.Shader)
 	if err != nil {
 		return fmt.Errorf("failed to load shader %s: %s", game.Conf.Shader, err)
 	}
 
-	shader, err := ebiten.NewShader(data)
+	if game.Conf.Background != "" {
-	if err != nil {
+		slog.Debug("Loading background", "image", game.Conf.Background)
-		return fmt.Errorf("failed to create new shader %s: %s", game.Conf.Shader, err)
+
+		img, err := asset.NewLiveAsset[*ebiten.Image](game.Conf.Background)
+		if err != nil {
+			return fmt.Errorf("failed to load image %s: %s", game.Conf.Background, err)
+		}
+
+		game.Background = img
 	}
 
 	game.Shader = shader
 
+	// user can customize TPS
+	ebiten.SetMaxTPS(game.Conf.TPS)
+
+	// setup shader bounds, by default we use window size
+	game.ShaderBounds = image.Rect(0, 0, game.Conf.Width, game.Conf.Height)
+
+	if len(game.Images) > 0 {
+		if game.Conf.Width < game.Images[0].Value().Bounds().Max.X {
+			// setup  geom. Shader might  be smaller  than window, we  use the
+			// first image -  if any - to determine its  size. We also enlarge
+			// the window if the first image is larger than the window.
+			game.Conf.Width = game.Images[0].Value().Bounds().Max.X
+			game.Conf.Height = game.Images[0].Value().Bounds().Max.Y
+		}
+
+		// adjust shader size by first image as well
+		game.ShaderBounds = game.Images[0].Value().Bounds()
+	} else {
+		// there might be no shader image but a background image, check it
+		if game.Background != nil {
+			game.Conf.Width = game.Background.Value().Bounds().Max.X
+			game.Conf.Height = game.Background.Value().Bounds().Max.Y
+		}
+	}
+
 	return nil
 }
 
@@ -120,32 +158,66 @@ func (g *Game) Down() {
 }
 
 func (game *Game) Update() error {
-	if game.CheckInput() {
+	for _, image := range game.Images {
-		slog.Debug("Key pressed", "Slider", game.Slider, "Flag", game.Flag)
+		if image.Error() != nil {
+			fmt.Println("warn: image reloading error:", image.Error())
+		}
 	}
 
+	if game.Shader.Error() != nil {
+		fmt.Println("warn: shader reloading error:", game.Shader.Error())
+	}
+
+	if game.Background != nil {
+		if game.Background.Error() != nil {
+			fmt.Println("warn: background image reloading error:", game.Background.Error())
+		}
+	}
+
+	if game.CheckInput() {
+		slog.Debug("Key pressed",
+			game.Conf.Flag, game.Flag,
+			game.Conf.Slider, game.Slider,
+			game.Conf.Ticks, fmt.Sprintf("%.02f", float64(game.Ticks)/60),
+			game.Conf.Mouse, fmt.Sprintf("%.02f, %.02f", game.Cursor[0], game.Cursor[1]),
+		)
+	}
+
+	mousex, mousey := ebiten.CursorPosition()
+	game.Cursor = []float64{float64(mousex), float64(mousey)}
+
 	game.Ticks++
 
 	return nil
 }
 
 func (game *Game) Draw(screen *ebiten.Image) {
-	op := &ebiten.DrawRectShaderOptions{}
+	if game.Background != nil {
+		op := &ebiten.DrawImageOptions{}
+		screen.DrawImage(game.Background.Value(), op)
+	}
 
-	mousex, mousey := ebiten.CursorPosition()
+	op := &ebiten.DrawRectShaderOptions{}
 
 	op.Uniforms = map[string]any{
 		game.Conf.Flag:   game.Flag,
 		game.Conf.Slider: game.Slider,
-		game.Conf.Ticks:  float64(game.Ticks) / 60,
+		game.Conf.Time:   game.Ticks / float64(ebiten.TPS()),
-		game.Conf.Mouse:  []float64{float64(mousex), float64(mousey)},
+		game.Conf.Mouse:  game.Cursor,
+		game.Conf.Ticks:  game.Ticks,
 	}
 
-	copy(op.Images[:3], game.Images)
+	for idx, image := range game.Images {
+		op.Images[idx] = image.Value()
+	}
 
 	op.GeoM.Translate(float64(game.Conf.X), float64(game.Conf.Y))
 
-	screen.DrawRectShader(game.Conf.Width, game.Conf.Height, game.Shader, op)
+	screen.DrawRectShader(
+		game.ShaderBounds.Dx(),
+		game.ShaderBounds.Dy(),
+		game.Shader.Value(),
+		op)
 }
 
 func (game *Game) Layout(outsideWidth, outsideHeight int) (int, int) {

go.mod

@@ -1,11 +1,12 @@
-module github.com/TLINDEN/kage-viewer
+module github.com/TLINDEN/kageviewer
 
 go 1.22
 
 require (
+	github.com/Zyko0/Ebiary/asset v0.0.0-20240304185439-be56fe8a2a6a // indirect
 	github.com/ebitengine/purego v0.6.0 // indirect
 	github.com/fatih/color v1.16.0 // indirect
-	github.com/fsnotify/fsnotify v1.6.0 // indirect
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/go-viper/mapstructure/v2 v2.0.0-alpha.1 // indirect
 	github.com/hajimehoshi/ebiten/v2 v2.6.7 // indirect
 	github.com/jezek/xgb v1.1.0 // indirect

go.sum

@@ -1,9 +1,13 @@
+github.com/Zyko0/Ebiary/asset v0.0.0-20240304185439-be56fe8a2a6a h1:kn4fhGvVA6T1lK7qWujIj3m7e9imCZe4MHBuBeflKgU=
+github.com/Zyko0/Ebiary/asset v0.0.0-20240304185439-be56fe8a2a6a/go.mod h1:4CqqwHRUbvGBpBd5ye4MxDA4k/XtZqrAD1sg9uxmcYI=
 github.com/ebitengine/purego v0.6.0 h1:Yo9uBc1x+ETQbfEaf6wcBsjrQfCEnh/gaGUg7lguEJY=
 github.com/ebitengine/purego v0.6.0/go.mod h1:ah1In8AOtksoNK6yk5z1HTJeUkC1Ez4Wk2idgGslMwQ=
 github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM=
 github.com/fatih/color v1.16.0/go.mod h1:fL2Sau1YI5c0pdGEVCbKQbLXB6edEj1ZgiY4NijnWvE=
 github.com/fsnotify/fsnotify v1.6.0 h1:n+5WquG0fcWoWp6xPWfHdbskMCQaFnG6PfBrh1Ky4HY=
 github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbSClcnxKAGw=
+github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=
+github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM=
 github.com/go-viper/mapstructure/v2 v2.0.0-alpha.1 h1:TQcrn6Wq+sKGkpyPvppOz99zsMBaUOKXq6HSv655U1c=
 github.com/go-viper/mapstructure/v2 v2.0.0-alpha.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
 github.com/hajimehoshi/ebiten/v2 v2.6.7 h1:rxlMxu487wZN/JteykmuGdO1qotOolL8vJDU85lPh7A=

main.go

@@ -21,7 +21,6 @@ import (
 	"fmt"
 	"log"
 	"os"
-	"runtime/debug"
 
 	"log/slog"
 
@@ -37,7 +36,7 @@ func main() {
 	}
 
 	if conf.Showversion {
-		fmt.Printf("This is kage-viewer version %s\n", VERSION)
+		fmt.Printf("This is kageviewer version %s\n", VERSION)
 		return
 	}
 
@@ -46,7 +45,6 @@ func main() {
 	if conf.Debug {
 		logLevel := &slog.LevelVar{}
 		// we're using a more verbose logger in debug mode
-		buildInfo, _ := debug.ReadBuildInfo()
 		opts := &yadu.Options{
 			Level:     logLevel,
 			AddSource: true,
@@ -55,12 +53,7 @@ func main() {
 		logLevel.Set(slog.LevelDebug)
 
 		handler := yadu.NewHandler(os.Stdout, opts)
-		debuglogger := slog.New(handler).With(
+		debuglogger := slog.New(handler)
-			slog.Group("program_info",
-				slog.Int("pid", os.Getpid()),
-				slog.String("go_version", buildInfo.GoVersion),
-			),
-		)
 		slog.SetDefault(debuglogger)
 	}
 

mkrel.sh

@@ -61,7 +61,7 @@ for D in $DIST; do
     GOOS=${os} GOARCH=${arch} go build -o ${binfile}
     mkdir -p ${tardir}
     cp ${binfile} README.md LICENSE ${tardir}/
-    echo 'tool = kage-viewer
+    echo 'tool = kageviewer
 PREFIX = /usr/local
 UID    = root
 GID    = 0