Skip to content

Latest commit

 

History

History
140 lines (125 loc) · 7.08 KB

README.md

File metadata and controls

140 lines (125 loc) · 7.08 KB
Raw

LynDJ

LynDJ is a desktop application designed for playing music for an audience. In particular, it is specialised to playing music for Lindy Hop socials. This DJ software allows playback of music easily and safely, and provides extra control and information for what is important for swing dancing.

Screenshot of the main interface

Main features

  • A graphical interface with a thematic design.
  • The interface is designed to prevent accidentally starting/stopping playback, for use with fiddly touch pads.
  • Select music from your library, and create a playlist.
  • Control volume for playback, and store these volume changes for future play-throughs of that track.
  • Track metadata on tracks such as BPM, recording age, style, energy level and when it was last played.
  • Sort your library by any metadata.
  • Set an end time for your session and get a warning when that time is approaching.
  • A frequency spectrograph to visualise upcoming musical cues.
  • Toggling between mono and stereo, for use with bad speaker set-ups.
  • An Auto-DJ will suggest the next track to play.
  • Trim silence from tracks automatically, or manually cut from the start or end of each track.

Support

This application is supported on:

  • Windows 10 or newer
  • Any Linux installation with Glibc 2.31 or newer

The file formats supported are:

  • WAV
  • MP3
  • FLAC
  • OGG/Vorbis
  • OGG/Opus

Installation

There are several ways to install this application onto your computer. This outlines your options, from easy to hard. Each option includes instructions for various platforms. If your platform is not listed, please select the most similar platform (e.g. for Arch Linux, installation is probably similar to Ubuntu). Note that the instructions are written for a clean installation of the operating system. You might already have some of the prerequisites installed.

AppImage: Ubuntu 22.04
  1. Download the latest AppImage file from the releases of this repository.
  2. Make the downloaded file executable by right-clicking on it, selecting "Properties" and under the "Permissions" tab checking the checkbox for "Allow executing file as program". Close the properties window.
  3. Double-click the AppImage file in order to launch the application.
Installer: Windows 10
  1. Download the latest installer from the releases of this repository.
  2. Double-click the downloaded file to launch the installer.
  3. Progress through the steps outlined by the installer. It will ask you where to install the application. For the default location in Program Files, administrator rights will be needed.
  4. At the end of the installation process, find the application in your start menu to launch it.
From source: Ubuntu 22.04
  1. Install system dependencies. To do this, open a terminal (Ctrl+Alt+T) and type the following:
sudo apt install python3-pip git portaudio19-dev
  1. Download the source code of LynDJ.
git clone https://github.com/Ghostkeeper/LynDJ
cd LynDJ
  1. Install LynDJ's Python dependencies.
python3 -m pip install -r requirements.txt
  1. You can now run the application from the terminal inside of this directory, by executing:
python3 lyndj.py
From source: Windows 10
  1. Install Python. Visit python.org and download the latest version of Python for Windows, using the installer. Run the installer to install Python. It is suggested to check the option "Add python.exe to PATH".
  2. Install Visual Studio Build Tools. Visit its download page and download the build tools. Run the installer. Select the "Desktop development with C++" package. Once installation is completed, you can close the installer.
  3. Install Git. Visit git-scm.com and download the latest version of Git for Windows. Run the installer to install Git. At the last screen of the installer, check that you wish to launch the Git terminal.
  4. Open a Git terminal. Navigate to a directory where you want to download LynDJ to, and download LynDJ, by typing the following:
git clone https://github.com/Ghostkeeper/LynDJ
  1. Open a normal terminal as well (press Windows key, then type cmd). Navigate to the LynDJ folder that was just created by Git. Install LynDJ's dependencies by executing:
python -m pip install -r requirements.txt
  1. You can now run the application from the terminal inside of this folder, by executing:
python lyndj.py

Usage

For usage instructions, please refer to the documentation.

Build

If you wish to modify this application, you can run the application from the source code as outlined above. However to distribute your modifications you can also create a build, which will make it easier for other people to install the application with your modifications. These are instructions to create a release build of this software.

Ubuntu 22.04
  1. Install Git in order to download the source code. To do this, open a terminal (Ctrl+Alt+T) and type the following:
sudo apt install git
  1. Download the source code of LynDJ.
git clone https://github.com/Ghostkeeper/LynDJ
cd LynDJ
  1. Run the script that generates an AppImage:
packaging/ubuntu.sh
  1. Test the application by running the AppImage that was generated.
chmod +x LynDJ.AppImage
./LynDJ.AppImage
Windows 10
  1. Install Python. Visit python.org and download the latest version of Python for Windows, using the installer. Run the installer to install Python. It is suggested to check the option "Add python.exe to PATH".
  2. Install Visual Studio Build Tools. Visit its download page and download the build tools. Run the installer. Select the "Desktop development with C++" package. Once installation is completed, you can close the installer.
  3. Install Git. Visit git-scm.com and download the latest version of Git for Windows. Run the installer to install Git. At the last screen of the installer, check that you wish to launch the Git terminal.
  4. Open a Git terminal. Navigate to a directory where you want to download LynDJ to, and download LynDJ, by typing the following:
git clone https://github.com/Ghostkeeper/LynDJ
  1. Install the NSIS installer software. Visit sourceforge.io and download the latest version of NSIS, using the installer. Run the installer to install NSIS.
  2. Open a normal terminal (press Windows key, then type cmd). Navigate to the LynDJ folder that was created by Git. Then run the script that generates an installer:
packaging/windows.bat
  1. You should now have an installer called LynDJ-installer.exe. Test it by installing LynDJ and running the application it installs.