{"id":13729437,"url":"https://github.com/Chowdhury-DSP/BYOD","last_synced_at":"2025-05-08T01:32:40.726Z","repository":{"id":37005980,"uuid":"378525798","full_name":"Chowdhury-DSP/BYOD","owner":"Chowdhury-DSP","description":"Build-your-own guitar distortion!","archived":false,"fork":false,"pushed_at":"2024-06-02T23:26:42.000Z","size":5681,"stargazers_count":424,"open_issues_count":37,"forks_count":22,"subscribers_count":12,"default_branch":"main","last_synced_at":"2024-08-04T02:08:39.882Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chowdhury-DSP.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"chowdsp","custom":"https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=93S67ZSKMBG68\u0026source=url"}},"created_at":"2021-06-20T00:02:12.000Z","updated_at":"2024-07-25T21:44:05.000Z","dependencies_parsed_at":"2023-02-14T15:01:12.184Z","dependency_job_id":"f6800e22-0488-4cb7-b7d4-34ad4a23eaa2","html_url":"https://github.com/Chowdhury-DSP/BYOD","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chowdhury-DSP%2FBYOD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chowdhury-DSP%2FBYOD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chowdhury-DSP%2FBYOD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chowdhury-DSP%2FBYOD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chowdhury-DSP","download_url":"https://codeload.github.com/Chowdhury-DSP/BYOD/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224688987,"owners_count":17353301,"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-03T02:01:00.270Z","updated_at":"2024-11-14T20:30:48.678Z","avatar_url":"https://github.com/Chowdhury-DSP.png","language":"C++","funding_links":["https://patreon.com/chowdsp","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=93S67ZSKMBG68\u0026source=url"],"categories":["Effects"],"sub_categories":[],"readme":"# BYOD (Build-Your-Own Distortion)\n\n[![Download Latest](https://img.shields.io/badge/download-latest-blue.svg)](https://github.com/Chowdhury-DSP/BYOD/releases/latest)\n![CI](https://github.com/Chowdhury-DSP/BYOD/workflows/CI/badge.svg)\n[![License](https://img.shields.io/badge/License-GPL3-blue.svg)](https://opensource.org/licenses/GPL-3.0)\n[![Downloads](https://img.shields.io/github/downloads/Chowdhury-DSP/BYOD/total)](https://somsubhra.github.io/github-release-stats/?username=Chowdhury-DSP\u0026repository=BYOD\u0026page=1\u0026per_page=30)\n\nBYOD is a guitar effects plugin with a customisable\nsignal chain that allows users to create their own guitar\ndistortion effects. The plugin contains a wide variety\nof distortion effects from analog modelled circuits\nto purely digital creations, along with some musical\ntone-shaping filters, and a handful of other useful\nsignal processors.\n\n## Quick Links\n- [Latest Release](https://chowdsp.com/products.html#byod)\n- [BYOD for iOS](https://apps.apple.com/us/app/byod/id1595313287)\n- [Nightly Builds](https://chowdsp.com/nightly.html#byod)\n- [User Manual](https://github.com/Chowdhury-DSP/BYOD/blob/main/manual/Manual.md)\n\n\u003cimg src=\"./manual/screenshots/full_gui.png\" alt=\"Plugin GUI\" height=\"400\"\u003e\n\nBYOD is open to contributions! If you would like to\nadd new guitar effect processors, please see\n[the documentation](./docs).\n\n## Building\n\nTo build from scratch, you must have CMake installed.\n\n```bash\n# Clone the repository\n$ git clone https://github.com/Chowdhury-DSP/BYOD.git\n$ cd BYOD\n\n# initialize and set up submodules\n$ git submodule update --init --recursive\n\n# build with CMake\n$ cmake -Bbuild\n$ cmake --build build --parallel 4\n```\n\nIf you'd like to make an optimized \"release\" build, it\nis suggested to use some slightly different build commands:\n```bash\n$ cmake -Bbuild -DCMAKE_BUILD_TYPE=Release\n$ cmake --build build --config Release --parallel 4\n```\n\nBYOD requires CMake version 3.15 or higher, however, BYOD\nCLAP builds require CMake 3.21 or higher. CLAP builds can\nbe disabled by adding `-DBYOD_BUILD_CLAP=OFF` to the first\nCMake command.\n\nAfter a successful build, the resulting plugin binaries will be located in\n`build/BYOD_artefacts`.\n\nIf building for Linux, please review the Linux dependencies used by\nthe [BYOD CI pipeline](https://github.com/Chowdhury-DSP/BYOD/blob/main/.github/workflows/cmake.yml#L30).\n\n### Compiling with OpenGL support\n\nBy default, OpenGL support is enabled on Windows, and is disabled on all other\nplatforms.  If you would like to override the default behaviour, you can pass the\nargument `-DCHOWDSP_ENABLE_OPENGL=\u003cON|OFF\u003e` to the CMake configure step.\n\n## Credits:\n\n- Extra Icons - [FontAwesome](https://fontawesome.com/)\n- Fuzzy Searching - [fuuzysearch](https://bitbucket.org/j_norberg/fuzzysearchdatabase)\n- C++ Utilities:\n  - [Magic Enum](https://github.com/Neargye/magic_enum)\n  - [Surge Synth Team's cpputils](https://github.com/surge-synthesizer/sst-cpputils)\n  - [ea_variant](https://github.com/eyalamirmusic/Variant)\n\nCredits for the individual processors are shown on\nthe information page for each processor. Big thanks to all who\nhave contributed!\n\n## License\n\nBYOD is open source, and is dual-licensed under the \nGeneral Public License Version 3. For more details, \nplease see the [licensing documentation](./docs/Licensing.md). Enjoy!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChowdhury-DSP%2FBYOD","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FChowdhury-DSP%2FBYOD","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChowdhury-DSP%2FBYOD/lists"}