@luxdamore/nuxt-canvas-sketch
v1.8.7
Published
๐๐จ Generative Art is the idea realized as genetic code of artificial events, as construction of dynamic complex systems able to generate endless variations. This is also a nuxt-module (@luxdamore/nuxt-canvas-sketch) - [three.js, tensorflow.js and gsap a
Downloads
26
Maintainers
Readme
๐๐จ Generative Art || Nuxt Canvas Sketch (three.js, tensorflow.js and gsap)
Generative Art is the idea realized as genetic code of artificial events, as construction of dynamic complex systems able to generate endless variations. This is also a nuxt-module (@luxdamore/nuxt-canvas-sketch) - [three.js, tensorflow.js and gsap are not included].
๐ Motivation
I'm introducing myself into the Generative art, 3D art, Visual design and Creative coding worlds.
So, why i can't do this with my favorite libraries and framework?
Infact, this is also a module for NuxtJS, it inject the canvas-sketch library with canvas-sketch-utils
and load-asset
(from the creative coder Matt DesLauriers).
After installation, you have access in NuxtJS (on the client-side) at two things, $canvasSketch
(the main module, used internally) and at the method $sketch
(it starts the sketch).
Check out the src/pages folder for some demos. Every page correspond to an example in the main website.
N.B.: This is a work-in-progress project, I'm learning and testing new things here.
Setup
- Install
@luxdamore/nuxt-canvas-sketch
as a dependency:yarn add @luxdamore/nuxt-canvas-sketch
;- or,
npm install --save @luxdamore/nuxt-canvas-sketch
;
- Append
@luxdamore/nuxt-canvas-sketch
to themodules
array of yournuxt.config.js
.
Configuration
// nuxt.config.js
export default {
// Module injection
modules: [ '@luxdamore/nuxt-canvas-sketch' ],
// Module configuration
canvasSketch: {
hideErrorsInConsole: false,
hideGenericMessagesInConsole: false, // `true` in production
},
};
Usage
I'm using the sketchManager, because i think with VueJS it's the better way to remove and clean handlers during the destroy phase.
<template>
<div class="canvas__container">
<canvas ref="canvas" />
</div>
</template>
<script>
// Page, component or layout
export default {
data: () => (
{
sketchManager: null,
}
),
async mounted() {
try {
this.sketchManager = await this.$sketch(
// Settings of the sketch
{
maxPixelRatio: 3,
hotkeys: false,
// or you can pass a DOMCanvasElement ex.
// document.querySelector( 'canvas' )
canvas: this.$refs.canvas,
},
// Method for the rendering
this.sketch,
);
// Ensure every listener is removed on-component-destoy
this.$once(
'hook:beforeDestroy',
() => this.sketchManager.unload()
);
} catch( e ) {
console.error(
e
);
}
},
methods: {
sketch({ context }) {
// Here you start coding-art
return ({ context }) => {
// Here you can return some animated stuff
};
},
},
};
</script>
<style scoped>
canvas {
position: absolute;
top: 0;
left: 0;
z-index: 1;
display: block;
width: 100vw;
height: 100vh;
margin: 0;
padding: 0;
}
</style>
Related things
ThreeJS
There are lots of examples based on threejs
, but it's not included, You can install the library with:
# cmd
yarn add three # or npm install --save three
There si also a ThreeJS starter template based on the plugin.
Gsap (GreenSock)
There are some examples based on the gsap
library, but it's not included, You can install the library with:
# cmd
yarn add gsap # or npm install --save gsap
Check the layout navigation example.
Tensorflow - Machine Learning and face recognition with Facemesh
TensorFlow.js and Facemesh are not included, but you can follow the installation process here:
# cmd
yarn add @tensorflow/tfjs-backend-cpu @tensorflow/tfjs-converter @tensorflow/tfjs-core # or npm install --save @tensorflow/tfjs-backend-cpu @tensorflow/tfjs-converter @tensorflow/tfjs-core
There si also an example with ThreeJS and Tensorflow based on the plugin.
Extra Resources
CanvasSketch
ThreeJS and Shaders
Videos about creative coding and 3D art
๐ฉ๐ปโ๐ป๐จ๐ปโ๐ป Development
- Clone the repository:
git clone https://github.com/LuXDAmore/generative-art.git
;
- Install dependencies:
yarn install
(ornpm install
);
- Start a development server:
yarn dev
(ornpm run dev
);
- Test your code:
yarn test
(ornpm run test
);
- Extra, generate the documentation (Github Pages):
yarn generate
(ornpm run generate
);- the content is automatically generated into the
/docs
folder.
๐ Issues
Please make sure to read the issue reporting checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.
๐ Discussions
We're using Github discussions as a place to connect with other members of our community. You are free to ask questions and share ideas, so enjoy yourself.
๐ฅ Contribution
Please make sure to read the contributing guide before making a pull request.
๐ Changelog
Details changes for each release are documented in the release notes.
๐ License
MIT License // Copyright (ยฉ) 2019-now Luca Iaconelli
๐ผ Hire me
๐ธ Are you feeling generous today?
If You want to share a beer, we can be really good friends ๐
โ It's always a good day to be magnanimous - cit.
๐ Inspired by
All my thanks goes to Matt DesLauriers and Yuri Artyukh for those useful libraries and tutorials.