Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.45 KB

README.md

File metadata and controls

35 lines (28 loc) · 1.45 KB
Raw

Otter

Declarative animation library for Roblox Lua built around (but not limited to) springs.
 

Running the Storybook

To see the examples from the docs in action, check out the storybook:

  1. Make sure you've installed tools (you may need to run foreman install)
  2. Run rotrieve install to install dependencies
  3. Open the storybook.rbxp file in Roblox Studio
  4. Click the Storybook plugin under the "Plugins" tab to open the storybook UI
  5. Select the storybook titled "React + Otter"

Running the Benchmarks

  1. Make sure you've installed tools (you may need to run foreman install)
  2. Run rotrieve install to install dependencies
  3. Run evaluate run default.project.json to run the benchmarks
  4. Benchmark ouptut will be generated in bin/benchmarks