From 30fb618da8a24c34a0d387e92519351d93b44a6c Mon Sep 17 00:00:00 2001 From: rominator1983 <13437300+rominator1983@users.noreply.github.com> Date: Wed, 7 Jun 2023 08:57:57 +0200 Subject: [PATCH 1/6] Describing user data in readme for PC users --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.rst b/README.rst index 8c9ac1da5..5f736044f 100644 --- a/README.rst +++ b/README.rst @@ -34,6 +34,26 @@ Compile libmod_utils:: $ make -C utils +User files +---------- + +Create directories to store your files + + $ mkdir ¨/modUserData + $ mkdir ¨/modUserData/Audio\ Loops + $ mkdir ¨/modUserData/Audio\ Recordings + $ mkdir ¨/modUserData/Audio\ Samples + $ mkdir ¨/modUserData/Audio\ Tracks + $ mkdir ¨/modUserData/Speaker\ Cabinets\ IRs + $ mkdir ¨/modUserData/Hydrogen\ Drumkits + $ mkdir ¨/modUserData/Reverb\ IRs + $ mkdir ¨/modUserData/MIDI\ Clips + $ mkdir ¨/modUserData/MIDI\ Songs + $ mkdir ¨/modUserData/SF2\ Instruments + $ mkdir ¨/modUserData/SFZ\ Instruments + $ mkdir ¨/modUserData/Aida\ DSP\ Models + $ mkdir ¨/modUserData/NAM\ Models + Run --- @@ -54,6 +74,7 @@ You will not get any audio, but you will be able to load plugins, make connectio And now you are ready to start the webserver:: $ export MOD_DEV_ENVIRONMENT=0 + $ export MOD_USER_FILES_DIR=~/modUserData $ python3 ./server.py Setting the environment variables is needed when developing on a PC. From 821ccca58f8aa52521018a42f6c42728d8866622 Mon Sep 17 00:00:00 2001 From: rominator1983 <13437300+rominator1983@users.noreply.github.com> Date: Wed, 7 Jun 2023 09:05:00 +0200 Subject: [PATCH 2/6] Removing $ signs so users can copy/paste the code from the readme more easily --- README.rst | 58 +++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/README.rst b/README.rst index 5f736044f..e9ef0d8a8 100644 --- a/README.rst +++ b/README.rst @@ -12,47 +12,47 @@ It will work in x86, other Linux distributions and Mac, but you might need to ad 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 + 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 + git clone git://github.com/moddevices/mod-ui + cd mod-ui Create a python virtualenv:: - $ virtualenv modui-env - $ source modui-env/bin/activate + virtualenv modui-env + source modui-env/bin/activate Install python requirements:: - $ pip3 install -r requirements.txt + pip3 install -r requirements.txt Compile libmod_utils:: - $ make -C utils + make -C utils User files ---------- -Create directories to store your files - - $ mkdir ¨/modUserData - $ mkdir ¨/modUserData/Audio\ Loops - $ mkdir ¨/modUserData/Audio\ Recordings - $ mkdir ¨/modUserData/Audio\ Samples - $ mkdir ¨/modUserData/Audio\ Tracks - $ mkdir ¨/modUserData/Speaker\ Cabinets\ IRs - $ mkdir ¨/modUserData/Hydrogen\ Drumkits - $ mkdir ¨/modUserData/Reverb\ IRs - $ mkdir ¨/modUserData/MIDI\ Clips - $ mkdir ¨/modUserData/MIDI\ Songs - $ mkdir ¨/modUserData/SF2\ Instruments - $ mkdir ¨/modUserData/SFZ\ Instruments - $ mkdir ¨/modUserData/Aida\ DSP\ Models - $ mkdir ¨/modUserData/NAM\ Models +Create directories to store your files:: + + mkdir ¨/modUserData + mkdir ¨/modUserData/Audio\ Loops + mkdir ¨/modUserData/Audio\ Recordings + mkdir ¨/modUserData/Audio\ Samples + mkdir ¨/modUserData/Audio\ Tracks + mkdir ¨/modUserData/Speaker\ Cabinets\ IRs + mkdir ¨/modUserData/Hydrogen\ Drumkits + mkdir ¨/modUserData/Reverb\ IRs + mkdir ¨/modUserData/MIDI\ Clips + mkdir ¨/modUserData/MIDI\ Songs + mkdir ¨/modUserData/SF2\ Instruments + mkdir ¨/modUserData/SFZ\ Instruments + mkdir ¨/modUserData/Aida\ DSP\ Models + mkdir ¨/modUserData/NAM\ Models Run --- @@ -60,22 +60,22 @@ 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 + 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 + 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 + export MOD_DEV_HOST=1 And now you are ready to start the webserver:: - $ export MOD_DEV_ENVIRONMENT=0 - $ export MOD_USER_FILES_DIR=~/modUserData - $ python3 ./server.py + export MOD_DEV_ENVIRONMENT=0 + export MOD_USER_FILES_DIR=~/modUserData + python3 ./server.py Setting the environment variables is needed when developing on a PC. Open your browser and point to http://localhost:8888/. From 683ea02d9f83eb1ac8a536a3f665ea89e0be8761 Mon Sep 17 00:00:00 2001 From: rominator1983 <13437300+rominator1983@users.noreply.github.com> Date: Wed, 7 Jun 2023 12:48:40 +0200 Subject: [PATCH 3/6] addding $ again --- README.rst | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/README.rst b/README.rst index e9ef0d8a8..7e7fb62ba 100644 --- a/README.rst +++ b/README.rst @@ -12,47 +12,47 @@ It will work in x86, other Linux distributions and Mac, but you might need to ad 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 + $ 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 + $ git clone https://github.com/moddevices/mod-ui.git + $ cd mod-ui Create a python virtualenv:: - virtualenv modui-env - source modui-env/bin/activate + $ virtualenv modui-env + $ source modui-env/bin/activate Install python requirements:: - pip3 install -r requirements.txt + $ pip3 install -r requirements.txt Compile libmod_utils:: - make -C utils + $ make -C utils User files ---------- Create directories to store your files:: - mkdir ¨/modUserData - mkdir ¨/modUserData/Audio\ Loops - mkdir ¨/modUserData/Audio\ Recordings - mkdir ¨/modUserData/Audio\ Samples - mkdir ¨/modUserData/Audio\ Tracks - mkdir ¨/modUserData/Speaker\ Cabinets\ IRs - mkdir ¨/modUserData/Hydrogen\ Drumkits - mkdir ¨/modUserData/Reverb\ IRs - mkdir ¨/modUserData/MIDI\ Clips - mkdir ¨/modUserData/MIDI\ Songs - mkdir ¨/modUserData/SF2\ Instruments - mkdir ¨/modUserData/SFZ\ Instruments - mkdir ¨/modUserData/Aida\ DSP\ Models - mkdir ¨/modUserData/NAM\ Models + $ mkdir ¨/mod-workdir/user-data + $ mkdir ¨/mod-workdir/user-data/Audio\ Loops + $ mkdir ¨/mod-workdir/user-data/Audio\ Recordings + $ mkdir ¨/mod-workdir/user-data/Audio\ Samples + $ mkdir ¨/mod-workdir/user-data/Audio\ Tracks + $ mkdir ¨/mod-workdir/user-data/Speaker\ Cabinets\ IRs + $ mkdir ¨/mod-workdir/user-data/Hydrogen\ Drumkits + $ mkdir ¨/mod-workdir/user-data/Reverb\ IRs + $ mkdir ¨/mod-workdir/user-data/MIDI\ Clips + $ mkdir ¨/mod-workdir/user-data/MIDI\ Songs + $ mkdir ¨/mod-workdir/user-data/SF2\ Instruments + $ mkdir ¨/mod-workdir/user-data/SFZ\ Instruments + $ mkdir ¨/mod-workdir/user-data/Aida\ DSP\ Models + $ mkdir ¨/mod-workdir/user-data/NAM\ Models Run --- @@ -60,22 +60,22 @@ 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 + $ 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 + $ 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 + $ export MOD_DEV_HOST=1 And now you are ready to start the webserver:: - export MOD_DEV_ENVIRONMENT=0 - export MOD_USER_FILES_DIR=~/modUserData - python3 ./server.py + $ export MOD_DEV_ENVIRONMENT=0 + $ export MOD_USER_FILES_DIR=~/modUserData + $ python3 ./server.py Setting the environment variables is needed when developing on a PC. Open your browser and point to http://localhost:8888/. From cbbec8110676a4f9e7ed8d915b87b75ab302e055 Mon Sep 17 00:00:00 2001 From: rominator1983 <13437300+rominator1983@users.noreply.github.com> Date: Wed, 7 Jun 2023 12:49:19 +0200 Subject: [PATCH 4/6] fixed export --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7e7fb62ba..ed8a7c3fd 100644 --- a/README.rst +++ b/README.rst @@ -74,7 +74,7 @@ You will not get any audio, but you will be able to load plugins, make connectio And now you are ready to start the webserver:: $ export MOD_DEV_ENVIRONMENT=0 - $ export MOD_USER_FILES_DIR=~/modUserData + $ export MOD_USER_FILES_DIR=¨/mod-workdir/user-data $ python3 ./server.py Setting the environment variables is needed when developing on a PC. From 698549c779a9cf80ba3f404e29173ba349665e24 Mon Sep 17 00:00:00 2001 From: rominator1983 <13437300+rominator1983@users.noreply.github.com> Date: Wed, 7 Jun 2023 12:54:08 +0200 Subject: [PATCH 5/6] better syntax --- README.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index ed8a7c3fd..88624fa57 100644 --- a/README.rst +++ b/README.rst @@ -39,20 +39,20 @@ User files Create directories to store your files:: - $ mkdir ¨/mod-workdir/user-data - $ mkdir ¨/mod-workdir/user-data/Audio\ Loops - $ mkdir ¨/mod-workdir/user-data/Audio\ Recordings - $ mkdir ¨/mod-workdir/user-data/Audio\ Samples - $ mkdir ¨/mod-workdir/user-data/Audio\ Tracks - $ mkdir ¨/mod-workdir/user-data/Speaker\ Cabinets\ IRs - $ mkdir ¨/mod-workdir/user-data/Hydrogen\ Drumkits - $ mkdir ¨/mod-workdir/user-data/Reverb\ IRs - $ mkdir ¨/mod-workdir/user-data/MIDI\ Clips - $ mkdir ¨/mod-workdir/user-data/MIDI\ Songs - $ mkdir ¨/mod-workdir/user-data/SF2\ Instruments - $ mkdir ¨/mod-workdir/user-data/SFZ\ Instruments - $ mkdir ¨/mod-workdir/user-data/Aida\ DSP\ Models - $ mkdir ¨/mod-workdir/user-data/NAM\ Models + $ mkdir "$HOME/mod-workdir/user-data" + $ mkdir "$HOME/mod-workdir/user-data/Audio Loops" + $ mkdir "$HOME/mod-workdir/user-data/Audio Recordings" + $ mkdir "$HOME/mod-workdir/user-data/Audio Samples" + $ mkdir "$HOME/mod-workdir/user-data/Audio Tracks" + $ mkdir "$HOME/mod-workdir/user-data/Speaker Cabinets IRs" + $ mkdir "$HOME/mod-workdir/user-data/Hydrogen Drumkits" + $ mkdir "$HOME/mod-workdir/user-data/Reverb IRs" + $ mkdir "$HOME/mod-workdir/user-data/MIDI Clips" + $ mkdir "$HOME/mod-workdir/user-data/MIDI Songs" + $ mkdir "$HOME/mod-workdir/user-data/SF2 Instruments" + $ mkdir "$HOME/mod-workdir/user-data/SFZ Instruments" + $ mkdir "$HOME/mod-workdir/user-data/Aida DSP Models" + $ mkdir "$HOME/mod-workdir/user-data/NAM Models" Run --- From 5af66e7d805bb30b7ba1ab61a372f15c8737c8d5 Mon Sep 17 00:00:00 2001 From: rominator1983 <13437300+rominator1983@users.noreply.github.com> Date: Thu, 15 Jun 2023 20:25:18 +0200 Subject: [PATCH 6/6] Update README.rst --- README.rst | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/README.rst b/README.rst index 88624fa57..8ec333419 100644 --- a/README.rst +++ b/README.rst @@ -34,26 +34,6 @@ Compile libmod_utils:: $ make -C utils -User files ----------- - -Create directories to store your files:: - - $ mkdir "$HOME/mod-workdir/user-data" - $ mkdir "$HOME/mod-workdir/user-data/Audio Loops" - $ mkdir "$HOME/mod-workdir/user-data/Audio Recordings" - $ mkdir "$HOME/mod-workdir/user-data/Audio Samples" - $ mkdir "$HOME/mod-workdir/user-data/Audio Tracks" - $ mkdir "$HOME/mod-workdir/user-data/Speaker Cabinets IRs" - $ mkdir "$HOME/mod-workdir/user-data/Hydrogen Drumkits" - $ mkdir "$HOME/mod-workdir/user-data/Reverb IRs" - $ mkdir "$HOME/mod-workdir/user-data/MIDI Clips" - $ mkdir "$HOME/mod-workdir/user-data/MIDI Songs" - $ mkdir "$HOME/mod-workdir/user-data/SF2 Instruments" - $ mkdir "$HOME/mod-workdir/user-data/SFZ Instruments" - $ mkdir "$HOME/mod-workdir/user-data/Aida DSP Models" - $ mkdir "$HOME/mod-workdir/user-data/NAM Models" - Run --- @@ -71,10 +51,13 @@ You will not get any audio, but you will be able to load plugins, make connectio $ export MOD_DEV_HOST=1 +If you want a different directory for the user files for impulse responses, neural network models and so on (the default is /data/user-files):: + + $ export MOD_USER_FILES_DIR=~/mod-workdir/user-data + And now you are ready to start the webserver:: $ export MOD_DEV_ENVIRONMENT=0 - $ export MOD_USER_FILES_DIR=¨/mod-workdir/user-data $ python3 ./server.py Setting the environment variables is needed when developing on a PC.