The Boilerplate Extension is a dummy RoboFont extension which doesn’t do anything useful. It was made as an example and template, to help you get started when building your own extensions. It is hosted on GitHub, so it’s easy to fork and make changes.
If you look at the source code of extensions by different developers, you will see that there are many different ways to organize files and publish extensions. The Boilerplate Extension shows a simple scheme which should be easy for beginners to understand and follow:
rf-extension-boilerplate ├── source/ │ ├── code/ │ ├── documentation/ │ └── resources/ ├── build/myExtension.roboFontExt │ ├── html/ │ ├── lib/ │ ├── resources/ │ ├── info.plist │ └── license ├── README.md ├── build.py └── license.txt
- Source folder
sourcefolder contains all source files, separated into sub-folders according to the Extension Folder Structure:
- code (.py files)
- documentation (html/css files)
- resources (icons, images etc)
These are the ‘master files’ which are edited by the developer.
- Build folder
buildfolder contains the generated extension package, which can be either built with a script (included in the repository) or with the Extension Builder.
This package is what gets distributed to users via Mechanic.
- Root folder
- The root folder of the repository contains the
build.pyscript, which generates the extension package from the source files. It also includes two meta-files for GitHub:
READMEfile with information about the repository
licensefile with the license for the repository