Files
forge-steel/DEVELOPMENT.md
T

166 lines
5.5 KiB
Markdown

# Working on this project
## Makefile.dev targets
```text
Usage: make --no-print-directory [target1] [target2] ...
Commands/Targets:
help show this message
init init project
clean clean build artifacts
full-clean remove any residual files
build build project
build-no-video build project no video in
run run project with $RUN_ARGS
run-lab run lab for working on default project
run-% run {project} with $RUN_ARGS
format format project
release-test test release
release-% build release {version}
rm-build rm -rf build
git-clean git clean -f -x
rm-deps rm -rf */.deps
clang-format clang-format -i src/*
exec-build ./build/forge $RUN_ARGS
exec-build-% ./build/forge --project={project} $RUN_ARGS
aclocal aclocal
autoconf autoconf
automake automake --add-missing
start-configure ./configure
make-% make {target}
cp-release cp forge-steel-xxx.tar.gz build/
git-submodule-update git submodule update --init --recursive
git-pull git pull origin main
prepare-configure-% sed -i {version} configure.ac
prepare-pkgbuild-% sed -i {version} PKGBUILD
git-commit-release git commit -am "forge (steel) v{version}"
makepkg makepkg
glsl-glyphs glsl-glyphs
```
## Release guide
```bash
# make full build
make -f Makefile.dev release-1.0.0
# push release
git push origin main --tags
# create release from tag on github
# attach .tar.gz to the github release
make -f Makefile.dev release-arch
# attach .pkg.tar.zst to the github release
make full-clean
```
## Roadmap
- [x] Basics
- [x] Create GLSL Window
- [x] Load static fragment shader into GLSL
- [x] Add default uniforms
- [x] Read fragment shader from file
- [x] Handle compilation errors
- [x] Minimal working fragment sample
- [x] Hot-reload fragment shader (with arg)
- [x] Specify fragment shader path
- [x] Force fullscreen
- [x] Select screen as argument / config
- [x] fps in window title
- [x] Clean code
- [x] Multi-stage shaders
- [x] Test 2 stages with render to texture
- [x] 2 in 2 fx 1 mix 1 fx layout
- [x] Include common code
- [x] 16 input + 16 fx definition and selection (with const param)
- [x] Feedback texture
- [x] Shaders config file
- [x] uniform config
- [x] fragment config
- [x] subroutines config
- [x] demo mode
- [x] random seed injected into shaders
- [x] internal texture size for speed
- [x] pass state as uniform
- [x] debug shader (and in monitor)
- [x] random mode / demo mode with R/D key
- [x] Clean code and fix things
- [x] Midi
- [x] Read Midi events
- [x] Read midi mapping config file
- [x] Write Midi events
- [x] Send midi data to shaders
- [x] Save midi state
- [x] Load midi state from last save
- [x] State machine with A/B switch
- [x] Tap-tempo feature
- [x] Clean code and fix things
- [x] Video input
- [x] Fixed camera video
- [x] Pass video info to shaders
- [x] Sub process video reading
- [x] Shader based format mapping
- [x] Video mapping config file
- [x] Get first video size matching internal size
- [x] Other internal size for video
- [x] Pass input fps into shaders for debug
- [x] Clean code and fix things
- [x] Monitor screen
- [x] 2nd window
- [x] Use buffers as panels (INA A FXA / DEBUG A+B FXA+B / INB B FXB)
- [x] Clean code and fix things
- [x] Share openGL state between monitor and screen
- [x] Default project
- [x] split with includes
- [x] src 9 : sentences repeat h
- [x] src 10 : isometric grid
- [x] src 12 : pattern in my kitchen
- [x] src 13 : another pattern in my kitchen
- [x] src 14 : cursor with select
- [x] src 15 : random source
- [x] fx 11 : spill
- [x] fx 12 : game of life
- [x] fx 13 : sobel
- [x] fx 14 : colorize range (pretty color ranges)
- [x] fx 15 : random fx
- [x] frag 10 : move debug screen here
- [x] debug : add src/fx/A/B indicators
- [x] Other
- [x] `forge_project.cfg`
- [x] Define frag prefix in config
- [x] Use custom `#include xxx.glsl` preprocessor
- [x] Use snprintf isntead of sprintf (and strlcpy instand of strncpy)
- [x] Pass "heavy" struct as pointer to avoid stack overload
- [x] Clean and sort args
- [x] `--auto-random` / `--no-auto-random`
- [x] Dump failed compilation into tmp file
- [x] Update readme with usage documentation
- [x] Sample gif in README
- [x] Documentation in default config file
- [x] Clone "shaders" and config in system path at setup
- [x] Minimal sample shaders
- [x] Hotkey `0` to reset everything
- [x] Printable PDF of default scr/fx
- [x] Add NanoKontrol setup file
- [x] Find and fix opengl errors 0500 ?
- [ ] Extra features
- [x] `--auto-random-cycle=4`
- [x] Arrows (up-down: bpm / left-right: cycle)
- [x] Save states (numkey: load / shift + numkey: save)
- [x] (clean) static functions at top of files
- [x] Configurable key codes
- [x] Monitor improvements
- [x] Ignore some values in auto random
- [x] build without video in
- [ ] Update README monitor/keymap
- [x] Auto reconnect midi input
- [x] Auto reconnect video device
- [x] Key codes as inputs
- [ ] Mouse position and scroll as inputs
- [ ] Joystick as input
- [ ] Record show as text files
- [ ] Play from record text file
- [ ] Fixes
- [ ] Try to write NanoKontrol config
- [x] Investigate video device fps loss (bad unregister ?)