selectoplasm

Selectoplasm Plugins - an overview

Greetings! Thanks for considering creating your own Selectoplasm plugins. Let's get straight into it.

First, your plugin needs a folder. You should name that folder what you want your plugin to be called.

*your project root folder*
.selectoplasm/
├── plugins/
│   ├── {your-plugin-name}/ *Put your plugin folder here*
│   │   ├── README.md *required*

Next, inside your plugin folder, you MUST have a README.md file. This is what Selectoplasm looks for during load in order to detect plugins, so if your plugin has every file except a README, it's not going to load. You don't technically have to put anything inside the README, but, you know, since you have to make it anyway, you might as well write something helpful, right?

There's no manifest information or anything like that. Selectoplasm automatically gets all the information it needs, so you can write whatever you want in your README.

Once you have a folder with a README.md inside it, every other file is optional. Here's a list of files you can add, and over the next few pages, we'll go into detail about how each one works.

- README.md *required*
- utility.css *optional*
- config.html *optional*
- worker.js *optional* **best used with config.html**
- preview.html *optional*
- preview.css *optional*

*You should have at least one optional file or your plugin won't do anything!*

We'll start with the simplest plugin you can make: a static selection of utility classes, and then we'll get progressively more complex. But even then, it's very simple!