@fms-cat/automaton-with-gui
v4.2.0
Published
Animation engine for creative coding, with GUI!
Downloads
17
Readme
automaton-with-gui
Animation engine for creative coding, with GUI!
It's an extended variant of the original Automaton engine
Originally made for Shift, my WebGL demo
Playground!
Try our playground! It comes with bunch of examples.
https://fms-cat.github.io/automaton/automaton-with-gui
You might want to also check examples of original Automaton.
Install
Include directly
automaton-with-gui.js
automaton-with-gui.min.js
automaton-with-gui.module.js
automaton-with-gui.module.min.js
.min
builds are minified. otherwise it isn't minified and comes with source maps..module
builds are ESM. otherwise it's UMD.
If you want to use the UMD one using iife, everything is exposed onto global under the name AUTOMATON_WITH_GUI
.
You might want to use automaton.min.js
of the core engine without GUI for production stage.
Code like this:
const { AutomatonWithGUI } = AUTOMATON_WITH_GUI;
const data = await ( await fetch( 'automaton.json' ) ).json();
const automaton = new AutomatonWithGUI(
data,
{
gui: yourDesiredMountpointDOM
}
);
// ...
npm
https://www.npmjs.com/package/@fms-cat/automaton-with-gui
# npm install @fms-cat/automaton-with-gui
yarn add @fms-cat/automaton-with-gui
then code like this:
// const { AutomatonWithGUI } = require( '@fms-cat/automaton-with-gui' );
import { AutomatonWithGUI } from '@fms-cat/automaton-with-gui';
const data = await ( await fetch( 'automaton.json' ) ).json();
const automaton = new AutomatonWithGUI(
data, // it's okay to be `undefined`
{
gui: yourDesiredMountpointDOM
}
);
// ...
Docs
https://fms-cat.github.io/automaton/automaton-with-gui/docs/