rodux - GitLite

KO | EN

gitlite — search

#react #go #android #rust #deep-learning #linux #macos #nodejs #windows #awesome-list #pytorch #security #mcp #open-source

rodux

(★ 332)

A state management library for Roblox Lua inspired by Redux

File Explorer

Download Latest Version (.zip)

- - ci.yml
- - devtools.md
  - error-reporters.md
  - middleware.md
  - thunks.md
- - actions.md
  - installation.md
  - motivation.md
  - reducers.md
  - store.md
- api-reference.md
- debugging.md
- example.md
- index.md
- withroact.md
- lemur
- testez
- - actions.lua
  - reducers.lua
  - store.lua
  - thunks.lua
- .luaurc
- combineReducers.lua
- combineReducers.spec.lua
- createReducer.lua
- createReducer.spec.lua
- init.lua
- init.spec.lua
- loggerMiddleware.lua
- loggerMiddleware.spec.lua
- makeActionCreator.lua
- makeActionCreator.spec.lua
- makeThunkMiddleware.lua
- NoYield.lua
- NoYield.spec.lua
- prettyPrint.lua
- Signal.lua
- Signal.spec.lua
- Store.lua
- Store.spec.lua
- thunkMiddleware.lua
- thunkMiddleware.spec.lua
- lemur.lua
- runner.server.lua
.darklua.json
.editorconfig
.gitignore
.gitmodules
.luacheckrc
.luacov
CHANGELOG.md
CONTRIBUTING.md
default.project.json
foreman.toml
LICENSE
mkdocs.yml
multipack.toml
README.md
requirements.txt
rotriever.toml
selene.toml
testez.d.lua
testez.toml
wally.toml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<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](https://github.com/Roblox/rodux/releases).
* 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](https://github.com/LPGhatguy/rojo) to sync the files into a place

## Usage
Rodux works just like [Redux](https://redux.js.org)'s base API.

See the official [Rodux Documentation](https://roblox.github.io/rodux/) for more details.

```lua
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](CONTRIBUTING.md) for information.

## License
Rodux is available under the Apache 2.0 license. See [LICENSE](LICENSE) for details.