zokku dj for Linux - quick start
================================

Thanks for getting zokku dj. Feature tour: https://zokku.app/dj/

zokku dj is in beta: it is not the final product yet, and it will be updated until the final version.
This is the first Linux version of zokku dj. It was tested on Ubuntu 22.04 without sound or controller hardware:
sound devices, controllers and licence activation are still new on Linux. If something does not work,
"send report" (see IF SOMETHING GOES WRONG) tells us what happened.

WHAT IT NEEDS
- 64-bit Linux (x86_64) with glibc 2.35 or newer: for example Ubuntu 22.04, Debian 12, Fedora 36 or later.
- A desktop session (X11, or Wayland with XWayland).

START
- Unpack the folder zokku-dj anywhere you can write, for example in your home folder.
  Keep its files together: the effects, the stem models and the controller mappings are read from
  the folders next to the program.
- Start it with ./zokku-dj.sh, or double-click zokku-dj in your file manager.
- To add zokku dj to the applications menu of your desktop, run once:  ./zokku-dj.sh --add-to-menu

LICENCE
- Buy at https://zokku.app/dj/ . You pay once.
- In zokku dj the licence window offers "I bought it: activate". Press it and sign in, in the browser
  that opens, with the account you used to buy.
- A computer that stays offline: Settings > licence > offline activation, three steps.
- Without a licence the app opens but stays silent.
- A set never stops: if the licence stops being valid while you play, the app plays on until you close it.

AUDIO
- zokku dj plays through ALSA, or through JACK or PipeWire when they are running.
  To choose the device: click the zokku logo > "audio setup".
- AAC and M4A files need ffmpeg (for example: sudo apt install ffmpeg). WAV, FLAC, OGG, AIFF and MP3 work without it.

EFFECTS AND SAMPLER
- The 8 ZOKKU units (vela, ikipump, fuzzo, ascent, tammo, omoline, tatakit, kitto) are built in and work with
  your zokku dj licence.

CONTROLLERS
- MIDI controllers work when you plug them in: a card shows the model. Press "use it".
- The buttons, lights and screens of Native Instruments Traktor controllers (such as the Kontrol D2, S2, S4)
  and the screen of the Push 2 need permission to use the USB device. Give it once with the file
  70-zokku-dj.rules (the top of the file says what it does):
    sudo cp 70-zokku-dj.rules /etc/udev/rules.d/
    sudo udevadm control --reload-rules && sudo udevadm trigger
  Then unplug the controller and plug it in again.

UPDATES
- When a new version is ready, zokku dj says so at the bottom of the window. "Update now" downloads it,
  replaces the program in this folder and starts it again. The folder must be writable by you.
- Settings > library > "check for updates" turns the check off. Without updates from the app, download
  the new version from https://zokku.app/dj/ .
- Your library, playlists, cues, mappings and settings stay as they are.

YOUR DATA
- Library, settings and logs are in ~/.config/DJAppV1. Recordings go to the folder zokku dj in your Music
  folder (for example ~/Music/zokku dj; on a desktop in another language its own name, such as ~/Musica).
- To remove zokku dj, delete the folder zokku-dj, and ~/.local/share/applications/zokku-dj.desktop if you
  added it to the menu. Delete ~/.config/DJAppV1 too if you want your library gone.

IF SOMETHING GOES WRONG
- Settings, "send report": one click sends a short report (app version, system, audio card,
  controllers and the recent log; no music, no library, no names). At the first start you choose
  whether crash and freeze reports go out by themselves; you can change it any time.
- Privacy: https://zokku.app/privacy
- Write to hello@zokku.app

LICENCES AND SOURCE CODE
- The folder licences holds the licences of the parts of zokku dj made by others. SoundTouch, LAME and libusb
  are under the GNU LGPL: their complete source code is in the folder sources (sources/SOURCES.txt), and you
  may replace those libraries beside zokku-dj with your own builds of the same versions.
