@fms-cat/automaton-with-gui
TypeScript icon, indicating that this package has built-in type declarations

4.2.0 • Public • Published

automaton-with-gui

Latest NPM release

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!

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

.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/

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i @fms-cat/automaton-with-gui

Weekly Downloads

1

Version

4.2.0

License

MIT

Unpacked Size

12 MB

Total Files

299

Last publish

Collaborators

  • fms-cat