Difference between revisions of "How To Make a MPB Package"

From MOD Wiki
Jump to navigation Jump to search
(Created page with "This page describes how to make a plugin package for mod-plugin-builder (or MPB for short) Few things about the build script and Buildroot Buildroot is based on packages to...")
 
Line 1: Line 1:
 
This page describes how to make a plugin package for mod-plugin-builder (or MPB for short)
 
This page describes how to make a plugin package for mod-plugin-builder (or MPB for short)
  
Few things about the build script and Buildroot
+
Plugin packages are buildroot files. Because of that it must comply with Buildroot rules.<br>
 
 
Buildroot is based on packages to build things. An LV2 plugin becomes a package and because of that it must comply with Buildroot rules.
 
 
A few important notes:
 
A few important notes:
 
+
* The package name is defined by the folder name and cannot contain '.'
    The package name is defined by the folder name and cannot contain '.'
+
* There must be a <packagename>.mk file inside the package folder
    There must be a <packagename>.mk file inside the package folder
+
* The package name and '.mk' file name must be the same
    The package name and '.mk' file name must be the same
+
* Inside the '.mk' file all defined variables must start with the package name in uppercase replacing '-' with '_'
    Inside the '.mk' file all defined variables must start with the package name in uppercase replacing '-' with '_'
+
* You need to define the generated plugin bundle names in the <PACKAGE_NAME>_BUNDLES variable
    You need to define the generated plugin bundle names in the <PACKAGE_NAME>_BUNDLES variable
+
* Browse through other examples so you get an idea of other variations of the makefiles (how to use cmake or waf for example)
    Browse through other examples so you get an idea of other variations of the makefiles (how to use cmake or waf for example)
+
* If you want to rebuild after a change to your plugin or the .mk then it is often easiest to just delete the previous build's directory for your plugin ~/mod-workdir/plugins-dep/build/<packagename>-<version>
    If you want to rebuild after a change to your plugin or the .mk then it is often easiest to just delete the previous build's directory for your plugin ~/mod-workdir/plugins-dep/build/<packagename>-<version>
 

Revision as of 21:14, 13 September 2017

This page describes how to make a plugin package for mod-plugin-builder (or MPB for short)

Plugin packages are buildroot files. Because of that it must comply with Buildroot rules.
A few important notes:

  • The package name is defined by the folder name and cannot contain '.'
  • There must be a <packagename>.mk file inside the package folder
  • The package name and '.mk' file name must be the same
  • Inside the '.mk' file all defined variables must start with the package name in uppercase replacing '-' with '_'
  • You need to define the generated plugin bundle names in the <PACKAGE_NAME>_BUNDLES variable
  • Browse through other examples so you get an idea of other variations of the makefiles (how to use cmake or waf for example)
  • If you want to rebuild after a change to your plugin or the .mk then it is often easiest to just delete the previous build's directory for your plugin ~/mod-workdir/plugins-dep/build/<packagename>-<version>