{"id":13657873,"url":"https://github.com/mod-audio/mod-ui","last_synced_at":"2025-04-24T08:30:50.438Z","repository":{"id":9813963,"uuid":"11796548","full_name":"mod-audio/mod-ui","owner":"mod-audio","description":"Web-based interface for the MOD","archived":false,"fork":false,"pushed_at":"2025-03-31T15:17:43.000Z","size":32743,"stargazers_count":101,"open_issues_count":25,"forks_count":70,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-04-18T04:48:45.178Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mod-audio.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-07-31T17:20:14.000Z","updated_at":"2025-04-14T17:47:07.000Z","dependencies_parsed_at":"2023-11-18T00:11:38.432Z","dependency_job_id":"3af0c9e2-341a-47d2-8601-daee7cd70309","html_url":"https://github.com/mod-audio/mod-ui","commit_stats":null,"previous_names":["mod-audio/mod-ui","moddevices/mod-ui"],"tags_count":101,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mod-audio%2Fmod-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mod-audio%2Fmod-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mod-audio%2Fmod-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mod-audio%2Fmod-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mod-audio","download_url":"https://codeload.github.com/mod-audio/mod-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250430583,"owners_count":21429324,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T05:00:52.336Z","updated_at":"2025-04-24T08:30:45.421Z","avatar_url":"https://github.com/mod-audio.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"mod-ui\n======\n\nThis is the UI for the MOD software. It's a webserver that delivers an HTML5 interface and communicates with mod-host.\nIt also communicates with the MOD hardware, but does not depend on it to run.\n\nInstall\n-------\n\nThere are instructions for installing in a 64-bit Debian based Linux environment.\nIt will work in x86, other Linux distributions and Mac, but you might need to adjust the instructions.\n\nThe following packages will be required::\n\n    $ sudo apt-get install virtualenv python3-pip python3-dev git build-essential libasound2-dev libjack-jackd2-dev liblilv-dev libjpeg-dev zlib1g-dev\n\nNOTE: 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.\n\nStart by cloning the repository::\n\n    $ git clone git://github.com/moddevices/mod-ui\n    $ cd mod-ui\n\nCreate a python virtualenv::\n\n    $ virtualenv modui-env\n    $ source modui-env/bin/activate\n\nInstall python requirements::\n\n    $ pip3 install -r requirements.txt\n\nCompile libmod_utils::\n\n    $ make -C utils\n\nRun\n---\n\nBefore running the server, you need to activate your virtualenv\n(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)::\n\n    $ source modui-env/bin/activate\n\nmod-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::\n\n    $ mod-host -n -p 5555 -f 5556\n\nIf you do not have mod-host, you can tell mod-ui to fake the connection to the audio backend.\nYou will not get any audio, but you will be able to load plugins, make connections, save pedalboards and all that. For this, run::\n\n    $ export MOD_DEV_HOST=1\n\nAnd now you are ready to start the webserver::\n\n    $ export MOD_DEV_ENVIRONMENT=0\n    $ python3 ./server.py\n\nSetting the environment variables is needed when developing on a PC.\nOpen your browser and point to http://localhost:8888/.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmod-audio%2Fmod-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmod-audio%2Fmod-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmod-audio%2Fmod-ui/lists"}