{"id":"flipbook-labs/storyteller","name":"storyteller","scope":"flipbook-labs","platform":"roblox","description":"Mirrored from the Wally registry.","version":"1.5.0","latest":"1.5.0","versions":["0.1.0","0.1.1","0.2.0","0.2.1","0.3.0","0.4.0","0.4.1","0.4.2","0.4.3","0.5.0","0.6.0","0.7.0","1.0.0","1.1.0","1.1.1","1.2.0","1.3.0","1.4.0","1.5.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{"elttob/fusion":{"version":"^0.2.0","alias":"Fusion"},"jsdotlua/jest":{"version":"^3.10.0","alias":"Jest"},"jsdotlua/jest-globals":{"version":"^3.10.0","alias":"JestGlobals"},"flipbook-labs/module-loader":{"version":"^0.7.0","alias":"ModuleLoader"},"jsdotlua/react":{"version":"^17.0.2","alias":"React"},"jsdotlua/react-roblox":{"version":"^17.0.2","alias":"ReactRoblox"},"roblox/roact":{"version":"^1.4.4","alias":"Roact"},"jsdotlua/roact-compat":{"version":"^17.0.2","alias":"RoactCompat"},"csqrl/sift":{"version":"^0.0.8","alias":"Sift"},"osyrisrblx/t":{"version":"^3.0.0","alias":"t"}},"integrity":"6c067e5a016baa969e9badf61115976ca09879cb022be0ea24a27eab372ef78c","likes":0,"downloads":0,"install":"forest install flipbook-labs/storyteller","url":"https://forest.dev/p/roblox/flipbook-labs/storyteller","files":"https://api.forest.dev/ai/package/roblox/flipbook-labs/storyteller/files","readme":"\n# Storyteller\n\n[![CI](https://github.com/flipbook-labs/storyteller/actions/workflows/ci.yml/badge.svg)](https://github.com/flipbook-labs/storyteller/actions/workflows/ci.yml)\n\nStoryteller is a package for the discovery and rendering of UI stories and powers our storybook plugin [Flipbook](https://github.com/flipbook-labs/flipbook).\n\nThe API for this package focuses around...\n1. Validation for the Story format and Storybook format\n2. Discvoery of valid ModuleScripts with `.story` and `.storybook` extensions\n3. Loading of Stories and Storybooks into a sandbox with cacheless module requiring\n4. Rendering stories into a container with lifecycle callbacks for updating and unmounting\n\nThere also exist React hooks for ease of integration into storybook apps.\n\n## Features\n\n* Discover Storybooks and their Story files\n* Render stories written in React, Roact, Fusion, and any generic Roblox Gui.\n\n## Installation\n\n### Wally\n\n```toml\n[dependencies]\nStoryteller = \"flipbook-labs/storyteller@x.x.x\"\n```\n\n### Roblox Model\n\nDownload a copy of the rbxm from the [latest release](https://github.com/flipbook-labs/storyteller/releases/latest) under the Assets section, then drag and drop the file into Roblox Studio to add it to your experience.\n\n## Resources\n\nAPI documentation is available on [the official documentation website](https://flipbook-labs.github.io/storyteller).\n\n## Contributing\n\nContributions welcome! Proper steps on how to get started will come later but feel free to poke around in the meantime.\n\n## License\n\nThe contents of this repository are available under the MIT License. For full license text, see [LICENSE](LICENSE).\n","readmeTruncated":false}