https://github.com/mod-audio/mod-ui

Web-based interface for the MOD
https://github.com/mod-audio/mod-ui

Last synced: 3 days ago
JSON representation

Web-based interface for the MOD

• Host: GitHub
• URL: https://github.com/mod-audio/mod-ui
• Owner: mod-audio
• License: agpl-3.0
• Created: 2013-07-31T17:20:14.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T13:19:51.000Z (6 days ago)
• Last Synced: 2024-11-07T14:25:59.121Z (6 days ago)
• Language: JavaScript
• Size: 31.2 MB
• Stars: 98
• Watchers: 33
• Forks: 67
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
mod-ui

======

This is the UI for the MOD software. It's a webserver that delivers an HTML5 interface and communicates with mod-host.

It also communicates with the MOD hardware, but does not depend on it to run.

Install

-------

There are instructions for installing in a 64-bit Debian based Linux environment.

It will work in x86, other Linux distributions and Mac, but you might need to adjust the instructions.

The following packages will be required::

    $ sudo apt-get install virtualenv python3-pip python3-dev git build-essential libasound2-dev libjack-jackd2-dev liblilv-dev libjpeg-dev zlib1g-dev

NOTE: libjack-jackd2-dev can be replaced by libjack-dev if you are using JACK1; libjpeg-dev is needed for python-pillow, at least on my system.

Start by cloning the repository::

    $ git clone git://github.com/moddevices/mod-ui

    $ cd mod-ui

Create a python virtualenv::

    $ virtualenv modui-env

    $ source modui-env/bin/activate

Install python requirements::

    $ pip3 install -r requirements.txt

Compile libmod_utils::

    $ make -C utils

Run

---

Before running the server, you need to activate your virtualenv

(if you have just done that during installation, you can skip this step, but you'll need to do this again when you open a new shell)::

    $ source modui-env/bin/activate

mod-ui depends on mod-host and the JACK server running in order to make sound. So after you have JACK setup and running, in another terminal do::

    $ mod-host -n -p 5555 -f 5556

If you do not have mod-host, you can tell mod-ui to fake the connection to the audio backend.

You will not get any audio, but you will be able to load plugins, make connections, save pedalboards and all that. For this, run::

    $ export MOD_DEV_HOST=1

And now you are ready to start the webserver::

    $ export MOD_DEV_ENVIRONMENT=0

    $ python3 ./server.py

Setting the environment variables is needed when developing on a PC.

Open your browser and point to http://localhost:8888/.