{"id":"risebit/bitframe","name":"bitframe","scope":"risebit","platform":"roblox","description":"BETTER Replacement for TweenService, utilzing 2 different Tweening Type and got many Pre-made Animations & Optimizied.","version":"0.1.5","latest":"0.1.5","versions":["0.1.3","0.1.5"],"license":"MIT","licenseRating":"safe","licenseCaveats":["The package archive does not include its license text; the license is declared in its manifest metadata."],"licenseVerified":false,"dependencies":{},"integrity":"4badd2e40f54757b2106dcbdd9700d717d71780c64d3e61182c5910cb9483c55","likes":0,"downloads":0,"install":"forest install risebit/bitframe","url":"https://forest.dev/p/roblox/risebit/bitframe","files":"https://api.forest.dev/ai/package/roblox/risebit/bitframe/files","readme":"# BitFrames\r\n\r\nA powerful, fluent, and modular UI animation library for Roblox. Create stunning visual effects with ease.\r\n\r\n**BitFrames** is designed to be a better replacement for `TweenService`, offering two different tweening engines (Spring and Easing) and a suite of pre-made, optimized animations.\r\n\r\n## Features\r\n\r\n- **Fluent API**: Chainable methods for clean and readable code.\r\n- **Dual Tween**: Support for both physics-based `Spring` animations and standard `Easing` styles.\r\n- **Pre-made Effects**: Includes a variety of built-in effects like Entrance, Exit, Attention, Loop, and Text animations.\r\n- **Optimized**: Designed for performance with efficient memory management.\r\n- **Type Safe**: Full Luau type support for better autocomplete and strict typing.\r\n\r\n## Installation\r\n\r\n### Wally\r\n\r\nAppend the following to your `wally.toml`:\r\n\r\n```toml\r\n[dependencies]\r\nBitFrames = \"risebit/bitframe@0.1.4\"\r\n```\r\n\r\n## Usage\r\n\r\n### Basic Example\r\n\r\n```lua\r\nlocal BitFrames = require(path.to.BitFrames)\r\n\r\nlocal frame = script.Parent.Frame\r\nlocal animator = BitFrames.new(frame)\r\n\r\nanimator:fadeIn({\r\n    duration = 1,\r\n    style = BitFrames.Easing.Quad,\r\n    direction = BitFrames.Easing.Out,\r\n}):play()\r\n```\r\n\r\n### Chaining Effects\r\n\r\n```lua\r\nanimator\r\n    :fadeInUp()\r\n    :wait(1)\r\n    :pulse({ infinite = true })\r\n```\r\n\r\n### Text Effects\r\n\r\n```lua\r\nlocal textLabel = script.Parent.TextLabel\r\nlocal textAnimator = BitFrames.new(textLabel)\r\n\r\ntextAnimator:typewriter(\"Hello, World!\", {\r\n    speed = 0.05,\r\n    cursor = \"_\"\r\n})\r\n```\r\n\r\n## API Overview\r\n\r\n### Constructors\r\n\r\n- `BitFrames.new(instance: GuiObject): BitFramesObject`\r\n\r\n### Effect Categories\r\n\r\n- **Entrance**: `fadeIn`, `fadeInUp`, `scaleIn`, `dropIn`, etc.\r\n- **Exit**: `fadeOut`, `fadeOutDown`, `scaleOut`, `shrinkOut`, etc.\r\n- **Attention**: `pulse`, `shake`, `bounce`, `flash`, `jello`, etc.\r\n- **Loop**: `spin`, `float`, `breathe`, `glow`, etc.\r\n- **Text**: `typewriter`, `scramble`, `colorCycle`, `glitch`, etc.\r\n\r\n## Tween Type\r\n\r\nYou can switch between engines in the configuration:\r\n\r\n- **Easing**: Standard TweenService-like styles (Quad, Cubic, Elastic, etc.)\r\n- **Spring**: Physics-based animations (damping, stiffness, mass)","readmeTruncated":false}