# BYOD

**Repository Path**: cheng_lib/BYOD

## Basic Information

- **Project Name**: BYOD
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-27
- **Last Updated**: 2024-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BYOD (Build-Your-Own Distortion)

[![Download Latest](https://img.shields.io/badge/download-latest-blue.svg)](https://github.com/Chowdhury-DSP/BYOD/releases/latest)
![CI](https://github.com/Chowdhury-DSP/BYOD/workflows/CI/badge.svg)
[![License](https://img.shields.io/badge/License-GPL3-blue.svg)](https://opensource.org/licenses/GPL-3.0)
[![Downloads](https://img.shields.io/github/downloads/Chowdhury-DSP/BYOD/total)](https://somsubhra.github.io/github-release-stats/?username=Chowdhury-DSP&repository=BYOD&page=1&per_page=30)

BYOD is a guitar effects plugin with a customisable
signal chain that allows users to create their own guitar
distortion effects. The plugin contains a wide variety
of distortion effects from analog modelled circuits
to purely digital creations, along with some musical
tone-shaping filters, and a handful of other useful
signal processors.

## Quick Links
- [Latest Release](https://chowdsp.com/products.html#byod)
- [BYOD for iOS](https://apps.apple.com/us/app/byod/id1595313287)
- [Nightly Builds](https://chowdsp.com/nightly.html#byod)
- [User Manual](https://github.com/Chowdhury-DSP/BYOD/blob/main/manual/Manual.md)

<img src="./manual/screenshots/full_gui.png" alt="Plugin GUI" height="400">

BYOD is open to contributions! If you would like to
add new guitar effect processors, please see
[the documentation](./docs).

## Building

To build from scratch, you must have CMake installed.

```bash
# Clone the repository
$ git clone https://github.com/Chowdhury-DSP/BYOD.git
$ cd BYOD

# initialize and set up submodules
$ git submodule update --init --recursive

# build with CMake
$ cmake -Bbuild
$ cmake --build build --parallel 4
```

If you'd like to make an optimized "release" build, it
is suggested to use some slightly different build commands:
```bash
$ cmake -Bbuild -DCMAKE_BUILD_TYPE=Release
$ cmake --build build --config Release --parallel 4
```

BYOD requires CMake version 3.15 or higher, however, BYOD
CLAP builds require CMake 3.21 or higher. CLAP builds can
be disabled by adding `-DBYOD_BUILD_CLAP=OFF` to the first
CMake command.

After a successful build, the resulting plugin binaries will be located in
`build/BYOD_artefacts`.

If building for Linux, please review the Linux dependencies used by
the [BYOD CI pipeline](https://github.com/Chowdhury-DSP/BYOD/blob/main/.github/workflows/cmake.yml#L30).

### Compiling with OpenGL support

By default, OpenGL support is enabled on Windows, and is disabled on all other
platforms.  If you would like to override the default behaviour, you can pass the
argument `-DCHOWDSP_ENABLE_OPENGL=<ON|OFF>` to the CMake configure step.

## Credits:

- Extra Icons - [FontAwesome](https://fontawesome.com/)
- Fuzzy Searching - [fuuzysearch](https://bitbucket.org/j_norberg/fuzzysearchdatabase)
- C++ Utilities:
  - [Magic Enum](https://github.com/Neargye/magic_enum)
  - [Surge Synth Team's cpputils](https://github.com/surge-synthesizer/sst-cpputils)
  - [ea_variant](https://github.com/eyalamirmusic/Variant)

Credits for the individual processors are shown on
the information page for each processor. Big thanks to all who
have contributed!

## License

BYOD is open source, and is dual-licensed under the 
General Public License Version 3. For more details, 
please see the [licensing documentation](./docs/Licensing.md). Enjoy!