% Synergy Source Release
% bsp
% 2023

$(var:header)

  
  
$(buf!toc)

# Introduction
This archive contains the application (script) sources required to run Synergy and Eureka.


# Prerequisites

## Supported platforms
- a PC running Windows 10 or higher
- or a PC or other computer running Linux (e.g Debian 12)
- or a Mac running macOS 10.12+ (x64) or 13.x+ (arm64)
- an audio interface capable of low-latency I/O

## TKS runtime

### Precompiled TKS runtime
Precompiled binaries of the TKS runtime for Windows and macOS can be downloaded [here](http://tkscript.org/#precompiled).


### TKS runtime sources
For building the TKS runtime on Linux, macOS, or Windows, please see [here](http://tkscript.org/#source).

#### tks_install_helper.sh
To build tks from source on Windows, Linux, or macOS:

~~~~
$ mkdir tks\_install
$ cd $\_
$ wget http://tkscript.org/tks\_install\_helper.sh
$ chmod u+x tks\_install\_helper.sh
$ ./tks\_install\_helper.sh
~~~~
note: please install the homebrew / APT package dependencies prior to running this script (see [installation guide](http://tkscript.org/#source))


# Installation

## mProjects folder
The `mProjects/` folder should be copied to the home directory:
~~~
$ cp -r tks-projects/synergy/mProjects ~/
~~~
Alternatively, adjust the root path in `synergy\_config\_local.tks`.

note: this folder contains Synergy and Eureka project files, presets, samples, patches, and so on.


## Platform-dependent configuration files
There are default configuration files for each supported platform. See `macos/`, `linux/`, `windows/` subdirectories within the `synergy/` and `eureka/` application source folders.

### Synergy default config
~~~
$ cd tks-projects/synergy
$ cp linux/synergy\_config*.tks .
~~~
note: replace `linux` with `macos` or `windows` as required

### Eureka default config
~~~
$ cd tks-projects/eureka
$ cp linux/eureka\_config*.tks .
~~~
note: replace `linux` with `macos` or `windows` as required


## Step-by-step Linux build and installation instructions
For reasons of convenience, here are all command lines for installing Synergy and Eureka on a Linux machine.

TKS runtime:
~~~~
$ sudo apt-get install build-essential libsdl2-dev libsdl1.2-dev libsdl-net1.2-dev libpng-dev libfreetype-dev libgtk2.0-dev libzip-dev libgnutls28-dev libasound2-dev sox rubberband-cli
$ wget http://tkscript.org/tks\_install\_helper.sh
$ chmod +x tks\_install\_helper.sh
$ ./tks\_install\_helper.sh
$ sudo -- sh -c 'cd tks\_install\_helper\_tmp/ ; . ./setenv\_linux.sh ; m all\_install'
~~~~


Synergy:
~~~~
$ wget http://miditracker.org/files/synergy-miditracker-src-18Aug2023d.7z
$ 7z x synergy-miditracker-src-18Aug2023d.7z
$ cd synergy-miditracker-src-18Aug2023d/tks-projects/synergy/
$ cp linux/synergy\_config*.tks .
$ tks synergy
or
$ tks synergy_nosynthedit
~~~~

Install `mProjects/` folder to home directory:
~~~~
$ cd synergy-miditracker-src-18Aug2023d/tks-projects/synergy/
$ cp -r mProjects ~/
~~~~

Eureka:
~~~~
$ cd synergy-miditracker-src-18Aug2023d/tks-projects/eureka/
$ cp linux/eureka\_config*.tks .
$ tks eureka
~~~~



# Launching the Synergy sequencer

To start Synergy from source:
~~~~
$ cd tks-projects/synergy
$ tks synergy
~~~~

Instead of `tks.exe` you can also use the `synergy.exe` from a binary Synergy distribution, e.g.
~~~~
$ cd tks-projects/synergy
$ ../../../synergy-miditracker-win64-18Aug2023/synergy.exe synergy
~~~~

# Launching the Eureka DAW
To start Eureka from source:
~~~~
$ cd tks-projects/eureka
$ tks eureka
~~~~

Instead of `tks.exe` you can also use the `synergy.exe` from a binary Synergy distribution, e.g.
~~~~
$ cd tks-projects/eureka
$ ../../../synergy-miditracker-win64-18Aug2023/synergy.exe eureka
~~~~

important: Eureka must be started _after_ Synergy



$(buf!w3validator)

Document created on $(var:localdatetime)
].create
    
