README.md

Sketch Framework

Framework used to create generative art using pseudo-random and parametric algorithms. This library provides a hot reloading canvas to simplify developer workflow for art development. This is the developer interface for creating art using the tools provided by the @code-not-art/core canvas drawing library.

This code base provides a demo environment usable for art development, but it is intended to produce an NPM package with all the React UI components to embed a Sketch into any React based applicaiton. This it is used as the foundation for @code-not-art/template which provides a blank canvas to easily make your own generative works. If you are looking to write some code that makes some art, start there instead.

Running the Demo (Quick Start)

This repository is managed with pnpm. The following commands will probably work with your preferred package manager (by replacing pnpm in these commands with npm or yarn, as you prefer.

Note for Contributers: If submitting changes with with updated dependencies, please install these with pnpm and provide the generated updates for the pnpm-lock.yaml file.

1. Clone to your computer - How To

2. Install dependencies with pnpm:

   pnpm i
   

3. Start development server:

   pnpm start
   

   The server will run on localhost:1234.

4. The page will render the sketch defined in src/demos/basic.ts. Open this file your editor of choice and write your sketch there. The server will watch for changes to the file, drawing to the canvas on the browser whenever you save your work.

Other demo sketches to play with are in that demos folder, but need to be imported into src/demo.tsx and passed as a prop into the App element.

Sketch Interface and Controls

Key	Action
s	Save the current image
u	Shareable image URL - Create a shareable URL and copy that link to your clipboard
m	Show/Hide Parameter Menu
space	Draw new image with random image and color seeds.
↑	Move to next color seed, or generate a new one if at end of list. Draw new image.
↓	Move to previous color seed. Draw new image.
→	Move to next image seed, or generate a new one if at end of list. Draw new image.
←	Move to previous image seed. Draw new image.
c	Generate new color seed. Draw new image.
i	Generate new image seed. Draw new image.

The Sketch Interface (AKA. writing your sketch)

The canvas expects a prop of the Sketch type. This interface allows you to provide configuration details for your sketch (config), and interactable parameters that you can update in browser (params). There are several methods for available for you to implement that will interact with the canvas and the seeded random generators provided by the framework. The only one of these that are absolutely required to provide is the draw(props) method, all others have sensible (mostly empty) defaults.

Property	Type	Required	Description	Default
config	JSON matching type ConfigInput	No	Configure image and project properties such as canvas size.	Image size: 1080x1080 Color and Palette seeds: Random Seeds based on current date and time FrameRate: 60
params	An array of Param objects.	No	Adds to the browser menu list of adjustable parameters that control the sketch.	No interactive parameters
init(props)	Function providing SketchProps	No	Runs when sketch is first passed to the Canvas allowing for expensive up front work to be done once and not repeated when new images are generated.	No operations performed.
reset(props)	Function providing SketchProps	No	Runs when user requests a new image to be drawn. Use this to reset any data as needed between draws.	Clears the canvas back to empty (all transparent).
draw(props)	Function providing SketchProps	Yes	The main drawing actions of the sketch. This will be run once whenever a user requests a new image to be generated.	-
loop(props, frameData)	Function providing SketchProps and FrameData.	No	Will be called every frame of the animation loop controlled by the page. The framerate will attempt to match the value specified in config. The loop will stop once this function returns true (indicating the animation has finished).	No operations performed.

SketchProps

The SketchProps are provided provided to every function in the Sketch definition. They provide access to the Canvas, and to the seeded Random generators. The full list of properties available and links to their code or documentation is:

Property	Type	Description
canvas	@code-not-art/core.Canvas	Provides access to the canvas and 2D context directly, plus all the drawing tools provided by the code-not-art core library.
rng	@code-not-art/core.Random	Random number generator provided the image seed
palette	Palette	Random Color Palette with 5 randomly selected colors. Changing the color seed will update the colors in the palette without affecting the random seed of the rng Random generator provided in the SketchProps
params	StringMap<any>	The values for the parameters provided in the sketch definition. If these are updated in the UI then this params object will have the updated values.