Skip to content

Add script to generate template effect files #7910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

regulus79
Copy link
Contributor

@regulus79 regulus79 commented May 29, 2025

This PR allows users to generate all the boilerplate code needed to make an effect with a single script, instead of having to manually copy Amplifier and rename everything.

How to use

First checkout this PR

git fetch origin pull/7910/head:generate-effect
git switch generate-effect

Then enter the plugins folder

cd plugins

Run the python script!

>>> python setupeffect.py

Effect Name (UpperCamelCase): TestEffect
Lowercase version: testeffect, Uppercase version: TEST_EFFECT
Effect Name (Human readable, spaces allowed): Test Name
Effect Description: Test Description
Effect Author: Me
Number of knobs: 7
Creating directory /home/user/lmms/plugins/TestEffect
TestEffect template files successfully written to /home/user/lmms/plugins/TestEffect
Updated ../cmake/modules/PluginList.cmake

Then rebuild lmms, and check out your new effect!

image

You just saved 5-10 minutes of your life! Now you can start developing your effect right away!

@regulus79
Copy link
Contributor Author

I'm thinking it might be useful to be able to specify what the floatmodels/knobs are called, since it's a bit of a pain to rename them all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants