Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cdaein/vite-plugin-ssam-timelapse

Export a Canvas image at each file save. Use it with Ssam or other Canvas libraries
https://github.com/cdaein/vite-plugin-ssam-timelapse

canvas creative-coding generative-art ssam timelapse vite vite-plugin

Last synced: about 2 months ago
JSON representation

Export a Canvas image at each file save. Use it with Ssam or other Canvas libraries

Awesome Lists containing this project

README 

        
# vite-plugin-ssam-timelapse



This plugin is created to be used with [Ssam](https://github.com/cdaein/ssam) to create a visual documentation of your sketch over time. It may also be used with other libraries if you can get a Canvas object reference.



## Install



```sh

npm i -D vite-plugin-ssam-timelapse

```



## How it works



When the plugin detects a change in the sketch source code, it will export a PNG image with sequential numbering into `timelapse` directory. If the directory doesn't exist, it will make one for you. You can later convert the resulting image sequence into a video to create a visual documentation of your sketch. When you close the Vite server and later come back to the same sketch, it will continue incrementing image filenames from where you left off.



> ✋ If you use Git, you may want to include `timelapse` directory in `.gitignore`.



## How to set up



In Vite config:



```js

import { ssamTimelapse } from "vite-plugin-ssam-timelapse";



export default defineConfig({

  plugins: [ssamTimelapse()],

  // ...

});

```



## With Ssam



In your Ssam sketch source code:



```js

import { ssam } from "ssam";



const sketch = ({ wrap, canvas }) => {

  if (import.meta.hot) {

    import.meta.hot.on("ssam:timelapse-changed", () => {

      import.meta.hot?.send("ssam:timelapse-newframe", {

        image: canvas.toDataURL(),

      });

    });

  }



  wrap.render = () => {

    // your drawing code

  };

};



const settings = {

  dimensions: [800, 800],

};



ssam(sketch, settings);

```



## With Vanilla JS



You can use the plugin with Vanilla JS or other Canvas libraries as long as you can get a reference to the Canvas object.



```js

const canvas = document.createElement("canvas");

canvas.width = canvas.height = 600;

document.body.appendChild(canvas);

const ctx = canvas.getContext("2d")!;



// make changes to drawing code and save

ctx.fillStyle = `gray`;

ctx.fillRect(0, 0, 600, 600);

ctx.beginPath();

ctx.arc(300, 300, 300, 0, Math.PI * 2);

ctx.fillStyle = `white`;

ctx.fill();



// at each save, canvas image will be exported

if (import.meta.hot) {

  import.meta.hot.on("ssam:timelapse-changed", () => {

    import.meta.hot?.send("ssam:timelapse-newframe", {

      image: canvas.toDataURL(),

    });

  });

}

```



## Default Options



```js

ssamTimelapse({

  // detect changes in the src directory

  watchDir: "./src",

  // will create the directory if it does not exist

  outDir: "./timelapse",

  // overwrite existing files

  overwrite: false,

  // ignore dotfiles. empty files are ignored by default.

  // you can use regex, string or string[]

  ignored: /(^|[\/\\])\../

  // how quickly plugin responds to file change (in milliseconds). see Chokidar documentation

  stabilityThreshold: 10_000,

  // how many zeros to pad to filename

  padLength: 5,

  // console logging in browser

  log: true,

});

```



When `overwrite` is set to `true`, every time the Vite server restarts, it will overwrite existing files on the `outDir`.



To avoid too frequent image exports, the default `stabilityThreshold` is set to 10 seconds, meaning the plugin will wait 10 seconds for all file changes to be settled.



## Convert to MP4



Use a video editing program to convert the image sequence into a video file. If you have `ffmpeg` installed, it is as simple as running the following command:



```sh

ffmpeg -framerate 5 -pattern_type glob -i '*.png' -c:v libx264 -preset slow -crf 20 -pix_fmt yuv420p -y output.mp4

```



Note that `ffmpeg` expects the filenames to be sequential. From my testing on Mac, `'*.png'` will continue to work even if some images are missing, but if you get an error, you will need to rename them before running the ffmpeg command.



## License



MIT