Rodux

<h1 align="center">Rodux</h1> <div align="center"> <a href="https://github.com/Roblox/rodux/actions"> <img src="https://github.com/Roblox/rodux/workflows/CI/badge.svg" alt="GitHub Actions Build Status" /> </a> <a href="https://coveralls.io/github/Roblox/rodux?branch=master"> <img src="https://coveralls.io/repos/github/Roblox/rodux/badge.svg?branch=master" alt="Coveralls Coverage" /> </a> <a href="https://roblox.github.io/rodux"> <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" /> </a> </div> <div align="center"> A state management library for Roblox Lua inspired by <a href="https://redux.js.org">Redux</a>. </div> <div>&nbsp;</div>

Installation

Method 1: Model File (Roblox Studio)

• Download the rbxm model file attached to the latest release from the GitHub releases page.
• Insert the model into Studio into a place like ReplicatedStorage

Method 2: Filesystem

• Copy the src directory into your codebase
• Rename the folder to Rodux
• Use a plugin like Rojo to sync the files into a place

Usage

Rodux works just like Redux's base API.

See the official Rodux Documentation for more details.

local Rodux = require(script.Parent.Rodux)

local function reducer(state, action)
	state = state or {
		frobulations = 0,
	}

	if action.type == "frobulate" then
		return {
			frobulations = state.frobulations + 1,
		}
	end

	return state
end

local store = Rodux.Store.new(reducer)

store:getState() -- { frobulations = 0 }

store:dispatch({
	type = "frobulate",
})

store:getState() -- { frobulations = 1 }

Contributing

Contributions are welcome! See CONTRIBUTING.md for information.

License

Rodux is available under the Apache 2.0 license. See LICENSE for details.