1 Introduction

• The Synergy MIDI sequencer
• The Eureka DAW / plugin host (work in progress)
• Several ("indie") 2D / 3D games
• Proprietary software (e.g. in-house graphics design tools, log-file parsers, code generators, ..)
• Text processing tools
  • md - a markdown to HTML converter
  • org - an org-mode like text processor, mind map converter, and project plan scheduler + report generator
    

• OpenGL (ES)
• Window / Event handling (via SDL)
• Math (linear algebra)
• File system access
• Zip files
• Networking (Ethernet, Bluetooth)
• Low latency audio (ASIO, PortAudio, OSS, ALSA)
• MIDI
• XML based user interfaces (tkui, SVG, TrueType)
  

• M68K AmigaOS 3.x (CLI-only)
• x86 / x64 Windows (2000 / XP / 7 / 8 / 10 / 11)
• x86 / x64 / ARM Linux (e.g. Open Pandora, Raspberry Pi)
• arm64 / x86_64 macOS 10 / 13
  
  

2 License

Software written in TkScript may use any license (FOSS, closed source, ..).

3 Platform compatibility matrix

4 Downloads

4.1 Precompiled Binaries

on macOS, copy the extracted the files to /usr/local/ (optional)

4.2 Source

• tks-source
• tks-build
• yac, yingtest
• tkanalogrytm
• tkchipmunk (v7)
• tkfreetype2
• tkfileutils
• tkmath, tkoldmath, tkgmp
• tkopengl
• tksdl (Windows), tksdl12-compat, tksdl2 (Linux, macOS)
• tksdl_net, tkbluetooth
• tkmidi (Windows), tkmidi_alsa (Linux), tkmidi_portmidi (macOS)
• tkmidipipe
• tkportaudio, tkportaudio_alsa_async, tkportaudio_oss
• tkradiastools
• svg_loader, tktriangulate
• tksampler, tksamplechain, tksampleedit
• tksmdi
• tksqlite
• tkui
• tkunit
• tkvst2 (Windows), tkvst2 (stub), tkvst2 (nogui), tkvst2 (macOS),
• tkzip
  

How to build (via install helper): $ wget http://tkscript.org/tks_install_helper.sh $ chmod +x tks_install_helper.sh $ ./tks_install_helper.sh downloads the source packages and builds them tested on macOS 13, Debian GNU/Linux 11, Windows 10 How to build (manually): The first three packages (source, build, yac) are mandatory for building a command-line version of tks. The remaining packages are optional. Edit the toplevel makefile (makefile.linux, makefile.macos or makefile.msvc) to choose which additional plugins will be built. Edit+Run . setenv_linux.sh, . ./setenv_macos_arm64.sh, . ./setenv_macos_x86_64.sh or . setenv_msvc.sh to set up cross compiling / target platform / include+lib paths. It is recommended to set up a shell function for make invocation, e.g. m(){ make -j20 -f makefile.msvc $* ; } (done by setenv*) Requirements / Prerequisites: The Windows build environment requires MSYS2 and the Microsoft Visual Studio compiler, e.g. the free-as-in-beer Community Edition. The Linux build environment requires GCC / G++, GNU make, and GNU Bash. The macOS build environment requires Clang (xcode toolchain), make, zsh, and the following brew packages: sdl12-compat, sdl2, libpng, freetype (tested with arm64 and x86_64) (and optionally sdl_net, gnutls, libzip, portaudio). The plugin bindings use the YaC (Yet another Component object model) interface, and the YInG interface generator. To rebuild the bindings for a specific module, run $ m yac in the plugin (or tks-source) directory.

5 Examples

• tks-examples
  
  

6 Tools

• dog (API documentation generator, from 2009) (docs)
• md (markdown document generator, 2018-2022) (docs)
• org (org-mode-like document processor, 2020) (docs)
  
  

7 Games

• retrovaders2 (a Space Invaders like game, from 2001)
• loadmd2 (a loader / viewer for Quake2 models, from 2002)
• equalize_it (a SID player and collection of C64 tunes, from 2003)
• gkraft (2D cave flyer, from 2004)
• racer (3D racing game, from 2008)
• jumpy (2D jump'n'run, from 2010)
• tequila (a classic Amiga500 demo effect ported to OpenGL, from 2010)
  
  

8 Documentation