Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 1.73 KB

README.md

File metadata and controls

42 lines (35 loc) · 1.73 KB

kooljs

  • kooljs is a multithreaded animation tool.
  • its one task per animator instance
  • this project is still in development

how to run the example project

  • git clone [email protected]:ji-podhead/kooljs.git

  • cd example_project

  • copy the kooljs folder to the project folder and initialize the bun project

  • you can also run the start.sh to start and install

  • i left the vscode folder in the branch so you can directly debug it with chrome

    • firefox is apprently having some issues with triggering breakpoints on rhel

what can it do?

  • compute animations on a worker thread
  • add addtional logic like lambda functions
  • trigger animations and chaining

how to use

so far this repo was only tested with react

  • import the animator
  • create a function to initialize your animation object (examples->e1_init)
    • create the props, animation-objects, callbacks, or triggers here
      • await the initialization those functions in the main component
  • initialize the worker by calling Animator.init
    • its important that you do this after you initialized the other stuff because the Animator.init method will pass the typed arrays over to the worker
  • call the component you wanna animate and overwrite the targets of the animation objects with your useStates if your using react

roadmap

  • linear animation
  • rendering canvas
  • additional lerping techniques
  • matrix lerp and complex magrix calculcations via callback function
  • use special keywords in the callback to use the registry of the worker thread
  • clear codebase and use inheritance - triggering animations on the worker thread

info

a cool animation tool for js. name provided by thebusinessman0920_55597 and bomi from the programers hangout helped with the name!