| 
  • If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • Stop wasting time looking for files and revisions. Connect your Gmail, DriveDropbox, and Slack accounts and in less than 2 minutes, Dokkio will automatically organize all your file attachments. Learn more and claim your free account.

View
 

Software Environment Setup

Page history last edited by james.susinno@... 10 months, 2 weeks ago Saved with comment

 

The main repo is on bitbucket: https://bitbucket.org/DIY_Instruments/electric_eel_markii/src/master/

Clone the repo to your local machine using git or download a zip.

 

Desktop version

The synthesis software is carefully designed to run on STM32 and desktop PC's. It has been tested on Windows, MacOS, and Linux. It uses Glfw for graphical context and window creation, Bass for audio output, and Imgui for user interface components.

 

 

Windows Platform Setup Instructions

The following software toolchain is required on a windows machine to build the desktop app:

  • Compiler
  • CMake
  • Glfw libs

Once dev machine setup is complete, the basic instructions to get the latest code working are:

  • Generate build files
  • Run build to create executable
  • Launch executable

 

Visual Studio installation

To go the VS route, download the installer from here:

It'll surely want to connect to the web, to retrieve the real installer. Which will then run, and put the software on your machine. It's a great IDE, but if you really don't want every single action transmitted to Microsoft HQ at all times, try the cygwin/ming route.

 

Cygwin/MinGW32 installation

For the discerning freedom-conscious hacker, a free software toolchain is available that can build just about the same executable:

It won't be byte-for-byte exactly the same as the VS-built exe, but I can't tell the difference. Check your make version by running the following:

 

$ mingw32-make.exe --version

GNU Make 4.2.1

Built for x86_64-w64-mingw32

Copyright (C) 1988-2016 Free Software Foundation, Inc.

License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software: you are free to change and redistribute it.

There is NO WARRANTY, to the extent permitted by law.

 

CMake installation

The desktop project uses CMake as a build system: get the latest version and install.

At the time of this writing, I'm using 3.10.0 on one machine and 3.14.3 on another; both seem to work fine.

 

Glfw Library "installation" 

The Glfw library handles window creation. Download the 3.1.2 zip and extract it to C:/Lib/. Why C:/Lib? It's short and convenient, easy to type. If you'd like it in a different location, edit the CMakeLists.txt file in the project to point to that location. CMakeLists.txt

 

 

Linux Platform Setup Instructions

Install the same software as above, but for Linux! apt-get this, apt-get that - it's really a piece of cake.

 

 

Generate the Build Files

If using VS, this will be a "solution" .sln file and a ton of junk accompanying it.

If using mingw, a Makefile will be generated.

CMake is kind enough to drop all of this build-related garbage you don't really care about into a subdirectory when you tell it to. You can them exclude that subdirectory from version control, for maximum convenience.

 

Here's what my setup looks like:

 

 

  • Enter the full path of electric_eel_markii/desktop/audio_ui/ into the "Where is the source code" field.
  • Enter the full path of electric_eel_markii/desktop/audio_ui/_build into the "Where to build the binaries" field.
  • Click "Configure".
  • Create the directory when prompted.
  • Select a "generator" to match the compiler: MinGW Makefiles, or your VS version.
  • Click "Generate".

Your makefile should be in the directory specified in "Where to build".

 

 

Build the Executable

 

Visual Studio

Click "Open Project". Visual Studio will open and you can press ctrl-shift-B to build. Pressing F5 should run the app.

 

MinGW Makefiles

Navigate to the "Where to build the binaries" directory, then invoke:

 

mingw32-make.exe

 
An executable should be created.

 

Run the Executable

Copy bass.dll from lib/win32/ into wherever you built the exe. You might need the x64 version if you built it that way.

 

Run the executable and enjoy!

 

Comments (0)

You don't have permission to comment on this page.