ginpar 0.1.1

A static content generator for interactive and parametrisable p5.js canvases.

Ginpar

Awkwardly named after Generative Interactive Parametrisable Canvases.

Generate a static site that indexes a list of P5.js sketches and turns each of those into an interactive sketch.

• Sketches are inside a folder sketches/
• Will use the filename as the sketch name.
• Index of the site will contain a list of a tags for each sketch.
• Will read each sketch and create a page for each one:
  • A form will be created using a params object that specifies the type, range, step, and default values of the variables.
  • A fixed section will contain the canvas and will allow for easy saving, auto-naming using the seed, and scaling.

Current version may work for other libraries, but it's only meant for P5.js.

Following versions my guarantee support for different libraries.

How to use

1. Install Ginpar. pip install ginpar

2. Create config.toml to indicate the metadata of the website. You can copy this config.toml example.

3. Create sketches/ and add all your P5.js sketches.

4. For each script, you must define the ginpar.params object (preferably at the beginning). Read the ginpar.params API

   /* ## */
   const ginpar.params = {
   height: {
       value: 500,
       type: "number",
       range: [0, 4096]
   },
   my-variable: {
       value: .8,
       type: "slide",
       range: [0, 1],
       step: .05
       // ...
   },
   //   ...
   };
   /* ## */
   

   Note that the /* ## */ are the important thing to add!

5. Run python build.py.

6. Enjoy your website created at public/.

License

MIT