{"id":21689208,"url":"https://github.com/spotlightkid/dpf-faust-project-template","last_synced_at":"2026-03-03T01:07:30.713Z","repository":{"id":261844472,"uuid":"885495990","full_name":"SpotlightKid/dpf-faust-project-template","owner":"SpotlightKid","description":"A project template for DISTRHO Plugin Framework (DPF) audio effect plugins using FAUST. ","archived":false,"fork":false,"pushed_at":"2025-02-05T18:13:13.000Z","size":2440,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T09:36:14.117Z","etag":null,"topics":["audio-plugins","clap","copier","dpf","faust-dsp","jackaudio","ladspa","lv2","project-template","vst2","vst3"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpotlightKid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null}},"created_at":"2024-11-08T17:40:24.000Z","updated_at":"2025-04-05T18:14:13.000Z","dependencies_parsed_at":"2024-11-08T19:25:52.433Z","dependency_job_id":"583f1a5b-244b-4bd3-a59a-02010b25427f","html_url":"https://github.com/SpotlightKid/dpf-faust-project-template","commit_stats":null,"previous_names":["spotlightkid/dpf-faust-project-template"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/SpotlightKid/dpf-faust-project-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdpf-faust-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdpf-faust-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdpf-faust-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdpf-faust-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpotlightKid","download_url":"https://codeload.github.com/SpotlightKid/dpf-faust-project-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fdpf-faust-project-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30028264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T00:31:48.536Z","status":"ssl_error","status_checked_at":"2026-03-03T00:30:56.176Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["audio-plugins","clap","copier","dpf","faust-dsp","jackaudio","ladspa","lv2","project-template","vst2","vst3"],"created_at":"2024-11-25T17:21:56.307Z","updated_at":"2026-03-03T01:07:30.694Z","avatar_url":"https://github.com/SpotlightKid.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dpf-faust-project-template\n\nA [copier] project template for DISTRHO Plugin Framework ([DPF]) audio effect\nplugins using [FAUST] for the implementation of the DSP pipeline.\n\n[![quik start asciicast](./screencast/quick-start.gif)](https://asciinema.org/a/4MsiYdGOrL6haSwv9n94qr2p6)\n\n\n## Quickstart\n\nTo create a DPF effect plugin using this template, install `copier` and the\n`copier-templates-extensions` package (see the [installation instructions]) and\nthen run:\n\n```console\n$ copier copy --trust gh:SpotlightKid/dpf-faust-project-template \u003cmy-project\u003e\n```\n\nwhere `\u003cmy-project\u003e` should be the path to a non-existing directory where your\nnew project will be created. The name of this directory will also be used as\nthe name of Git repository, which will be ininialized in the newly created\nproject.\n\n**Note:** The `--trust` option is necessary because the project template runs\nsome additional tasks after the project generation and also loads some custom\nJinja template extensions included in the project template. Both things are\nconsidered \"unsafe\", because they can potentially run arbitray commands as the\nuser who generates a project from the template. The additional tasks are simple\nshell commands to set up a git repository with a sub module etc. You can have a\nlook at the [copier.yml](./copier.yml) file to review these commands\nbeforehand.\n\nEnter the plugin name and other info at the prompts. (See the\n[copier documentation] on how to change the default values for these prompts.)\n\nHere is an example (some output abbreviated for clarity):\n\n```console\n$ copier copy --trust gh:SpotlightKid/dpf-faust-project-template dpffaustgain\n🎤 project_name\n   DPF FAUST Gain\n🎤 plugin_description\n   A simple audio volume gain plugin\n🎤 author_name\n   Joe Doe\n🎤 domain\n   example.com\n🎤 github_username\n   joe.doe\n🎤 email\n   joe.doe@example.com\n🎤 plugin_brand\n   example.com\n🎤 The plugin name, which can be used as an identifier in source code\n   DPFFAUSTGain\n🎤 repo_name\n   dpffaustgain\n🎤 plugin_uri\n   https://example.com/plugins/dpffaustgain\n🎤 project_license\n   MIT\n🎤 version\n   0.1.0\n🎤 year\n   2024\n🎤 num_inputs (int)\n   1\n🎤 num_outputs (int)\n   1\n\nCopying from template version 0.2.0.post3.dev0+213caa6\n    create  .\n    create  Makefile\n    create  README.md\n    create  plugins\n    [...]\n\n \u003e Running task 1 of 11: echo 'Running post-project-generation hook...'\nRunning post-project-generation hook...\n \u003e Running task 2 of 11: echo 'Initializing new Git repository:'\nInitializing new Git repository:\n \u003e Running task 3 of 11: git init\nInitialized empty Git repository in .../dpffaustgain/.git/\n \u003e Running task 4 of 11: git remote add origin git@github.com:joe.doe/dpffaustgain\n \u003e Running task 5 of 11: echo 'Adding Git submodule for DPF library:'\nAdding Git submodule for DPF library:\n \u003e Running task 6 of 11: git submodule add https://github.com/DISTRHO/DPF.git dpf\nCloning into '.../dpffaustgain/dpf'...\n[...]\n \u003e Running task 7 of 11: echo 'Checking out submodules:'\nChecking out submodules:\n \u003e Running task 8 of 11: git submodule update --init --recursive\nSubmodule 'dgl/src/pugl-upstream' (https://github.com/DISTRHO/pugl.git) registered for path 'dpf/dgl/src/pugl-upstream'\nCloning into '.../dpffaustgain/dpf/dgl/src/pugl-upstream'...\nSubmodule path 'dpf/dgl/src/pugl-upstream': checked out 'e33b2f6b0cea6d6263990aa9abe6a69fdfba5973'\n \u003e Running task 9 of 11: echo 'Making initial Git commit:'\nMaking initial Git commit:\n \u003e Running task 10 of 11: git add -A\n \u003e Running task 11 of 11: git commit -m 'Initial commit'\n[master (root-commit) 4696c9d] Initial commit\n[...]\n\nYour DPF/FAUST audio effect plugin project is now ready!\nTo compile it, change into the 'dpffaustgain' directory and type 'make'.\nThe plugin binaries and bundles will be placed in the 'bin' subdirectory.\nHave fun!\n```\n\nA directory named after the second argument you gave to `copier` will be\ncreated and initialized as a Git repository and DPF added as a Git submodule.\n\nEnter the directory and run `make`:\n\n```console\n$ cd dpffaustgain\n$ make\n```\n\nThe resulting plugin binaries will be placed in the `bin` sub-directory of your\nproject.\n\nThe FAUST DSP implementation will be in in the `faust` sub-directory, in a file\nnamed `\u003cplugin_name\u003e.dsp` (in all lower-case). Adapt it as you see fit and run\n`make` again to re-generate the C++ source code from the the FAUST source and\nto rebuild the binaries. The second compilation will be much faster, because\nthe DPF library has already been built.\n\nThe static and generated source code for your plugin is in a sub-directory of\nthe `plugins` directory named after the value you specified for `plugin_name`\n(again in all lower-case).\n\nSee the `README.md` file in your generated project for more information on\ncompiling, prerequisites and how to install the finished plugin(s).\n\n\n## Requirements\n\nTo create a project using this cookie cutter template you need:\n\n* Python\n* Git\n* [copier]\n\nTo build the generated project, you need additional development tools. See the\n`README.md` file in your generated project for more information.\n\n\n## License\n\nThis copier template is released under MIT license. See the\n[LICENSE.md](./LICENSE.md) file for more information.\n\nWhen generating a project using this template, you may choose any license for\nthe resulting files which is compatible with the license of DPF and the plugin\nformats you want to distribute.\n\nThe `faustdoctor` architecture files in the `faust/arch` directory of generated\nprojects are distributed under the Boost Software License 1.0 and come with a\nspecial license exception, which can be found in the `LICENSE-EXCEPTION.md`\nfile in the same dierctory.\n\n\n## Authors\n\n* Christopher Arndt ([@SpotlightKid])\n* Jean Pierre Cimalando ([@jpcima]) - [faustdoctor] architecture files\n\n\n[copier]: https://github.com/copier-org/copier\n[copier documentation]: https://copier.readthedocs.io/en/stable\n[dpf]: https://github.com/DISTRHO/DPF\n[installation instructions]: https://github.com/copier-org/copier-templates-extensions?tab=readme-ov-file#installation\n[faust]: https://faust.grame.fr/\n[faustdoctor]: https://github.com/SpotlightKid/faustdoctor\n[@jpcima]: https://github.com/jpcima\n[@spotlightkid]: https://github.com/SpotlightKid\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspotlightkid%2Fdpf-faust-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspotlightkid%2Fdpf-faust-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspotlightkid%2Fdpf-faust-project-template/lists"}