Addons

An addon is software that adds on functionality to an existing software system.

Using Addons with q5.js

q5 is compatible with popular p5.js Addon Libraries, such as p5.sound, ml5.js, and p5play.

To use addons, simply load them after q5.js:

<script src="https://q5js.org/q5.js"></script>
<!-- load p5 addons after q5 -->
<script src="https://p5play.org/v3/planck.min.js"></script>
<script src="https://p5play.org/v3/p5play.js"></script>

Developing Addons for q5.js

q5 is compatible with p5 Addons because it aliases Q5 to p5 and also implements the p5.prototype.registerMethod function, so you can develop addons for q5 the same way you would for p5.js v1.

Q5.prototype.registerMethod('init', function() {
  // runs upon the initialization of an instance of Q5, before `preload`
});

Q5.prototype.registerMethod('pre', function() {
  // runs before each `draw` call
});

Q5.prototype.registerMethod('post', function() {
  // runs after each `draw` call
});

You can also develop an addon for q5.js that can be loaded the same way q5-core loads other q5 source modules. See the "Modular Use" wiki page for more info.

Q5.modules.yourAddon = ($, q) => {
  // your addon code
};

Note the parameter $ is the instance of q5. q is a proxy between the q5 instance and copies of non-Object properties in the global scope (if global mode is enabled). Only use q to update the value of non-Object properties.