tagoso / fxhash-p5-boilerplate

fx(hash)+p5.js boilerplate

Acknowledgments

I would like to extend my sincere gratitude to the following individuals for their contributions and resources:

• somaticbits: For the fxhash-p5-template on GitHub, which provided crucial insights and tools. Visit their repository here.

• Wanda Oliver: For the informative article on fx(hash) and template usage, which offered guidance and inspiration. You can read their article on fxhash here.

Project Setup Instructions

Getting Started

1. Initialize fxhash Project

   • Execute the command:

     fxhash create
     

     See the guide here

2. Keep these Files. DO NOT EDIT

   • fxhash.js - This is @fxhash/project-sdk, containing helper functions.
   • index.js - Contains the artist's code powering the generative artwork.
   • LICENSE - Declares usage rights of your code.

3. Cloning this fxhash p5 Boilerplate

   • Run the command:

     git clone https://github.com/tagoso/fxhash-p5-boilerplate.git
     

   • This includes:
     • index.html - HTML entry point.
     • sketch.js - For p5.js projects.
     • styles.css - For styling purposes.
     • READ.ME - Optional. You can delete this.

4. p5.js Library

   • Download p5.min.js here - Do not edit.

Project Structure

The project directory should look like this (alphabetically sorted):

├─ /assets (<= optional)
├─ fxhash.js
├─ index.html
├─ index.js
├─ LICENSE
├─ p5.min.js
├─ READ.ME
├─ sketch.js
├─ styles.css