https://github.com/Reselim/Flipper

A motion library for Roblox
https://github.com/Reselim/Flipper

animation otter roblox

Last synced: about 2 months ago
JSON representation

A motion library for Roblox

• Host: GitHub
• URL: https://github.com/Reselim/Flipper
• Owner: Reselim
• License: mit
• Created: 2020-08-18T18:54:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-25T10:33:48.000Z (about 3 years ago)
• Last Synced: 2024-11-08T15:06:52.615Z (3 months ago)
• Topics: animation, otter, roblox
• Language: Lua
• Homepage: https://reselim.github.io/Flipper/
• Size: 1.06 MB
• Stars: 125
• Watchers: 6
• Forks: 18
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-react-lua - **Repository**
• awesome-react-lua - **Repository**

README

        


	

	


	Flipper is an animation library for Roblox based around Motors and Goals.



# Installation

## Rojo

### 0.6.x+

Add this repository as a submodule into your packages directory. This example assumes the directory is `packages`.

```

git submodule add https://github.com/Reselim/Flipper packages/Flipper

```

### 0.5.x

Copy the `src` folder from this repository into your packages directory.

## npm (for roblox-ts)

Install the [`@rbxts/flipper`](https://www.npmjs.com/package/@rbxts/flipper) package using `npm` or `yarn`.

```

npm i @rbxts/flipper

```

## Without Rojo

Download the latest .rbxm file from [the releases page](https://github.com/Reselim/Flipper/releases) and drag it into studio.

# Usage

## With Roact

This example creates a button that shrinks when pressed.

```lua

local Example = Roact.Component:extend("Example")

function Example:init()

	self.motor = Flipper.SingleMotor.new(0)

	local binding, setBinding = Roact.createBinding(self.motor:getValue())

	self.binding = binding

	self.motor:onStep(setBinding)

end

function Example:render()

	return Roact.createElement("ImageButton", {

		Size = self.binding:map(function(value)

			return UDim2.new(0, 100, 0, 100):Lerp(UDim2.new(0, 80, 0, 80), value)

		end),

		Position = UDim2.new(0.5, 0, 0.5, 0),

		AnchorPoint = Vector2.new(0.5, 0.5),

		[Roact.Event.MouseButton1Down] = function()

			self.motor:setGoal(Flipper.Spring.new(1, {

				frequency = 5,

				dampingRatio = 1

			}))

		end,

		[Roact.Event.MouseButton1Up] = function()

			self.motor:setGoal(Flipper.Spring.new(0, {

				frequency = 4,

				dampingRatio = 0.75

			}))

		end

	})

end

return Example

```

Flipper works wonderfully with Roact on its own, but if you plan on using it for a lot of your components, [roact-flipper](https://github.com/Reselim/roact-flipper) will make that *much* easier.

## Without Roact

Check out the [demo script](test/demo.client.lua) in the test project!

# License

Flipper is licensed in full under the [MIT license](LICENSE). Note that it [contains code](src/Spring.lua) from another author, which is also under the MIT license.