README
Shaderpark
Library poweringShaderpark simplifies creating procedural graphics using javascript.
With just a few lines of code, create shaders which are:
- Animated
- Interactive
- 2D or 3D (with PBR)
Easily integrated with:
- webpages
- threejs
- touchdesigner
- unity (under development)
Example
(TODO)
Install
npm i shader-park-core
Live edit, remix and share your creations on shaderpark.com
Examples/Templates Repo
Dev Setup:
npm install
or
yarn install
Build:
npm run build
or
yarn build
Watch:
npm watch
or
yarn watch
CLI usage:
npm run toThreeJS my-sculpture.js
npm run toOffline my-sculpture.js
npm run toRawSDF4Meshing my-sculpture.js
For development with SP website:
In shader-park-core repo run
npm link
or
yarn link
In shader-park-website repo run
npm link shader-park-core
or
yarn link shader-park-core
API usage:
The simple cli tools in the converters directory are simple examples of how the API can be used. (TODO, put more examples in readme, and examples folder) For now, explore the available functions in index.js, and see their implementations in the targets directory.
To add new targets:
- Implement a class in targets that converts sculpt to the format your target requires (see existing targets for example of available tools for this)
- Expose the functions externally in index.js
- Implement a basic cli converter, (for now this means just copy-pasting an existing converter and swapping out the single converter function. The boilerplate could be factored out and the cli converters could be automatically generated) and use as a cli tool, or use API directly.