Charm
Atomic state management for Roblox.
npm package →
[](https://www.npmjs.com/package/@rbxts/charm)
[](LICENSE.md)
**Charm** is a Roblox state management library, inspired by [Jotai](https://jotai.org). Designed to be an alternative to [Reflex](https://littensy.github.io/reflex), Charm aims to bring an atomic and composable approach to your game's state.
> [!NOTE]
> Charm is incomplete and not ready for use.
## 📦 Setup
### TypeScript
Install Charm through your package manager of choice. \
[React](https://github.com/littensy/rbxts-react) is optional, but highly recommended.
```sh
npm install @rbxts/charm
yarn add @rbxts/charm
pnpm add @rbxts/charm
```
### Wally
Add `littensy/charm` to your `wally.toml` file.
```toml
[dependencies]
Charm = "littensy/charm@VERSION"
```
## 📚 Documentation
### `atom(state)`
### `derive(...atoms, combiner)`
### `subscribe(atom, listener)`
### `observe(atom, observer)`
### `split(atom, keyExtractor?)`
---
### `Atom(state?)`
### `Atom.get(selector?)`
### `Atom.set(state)`
### `Atom.memo(equalityFn)`
### `Atom.readonly()`
### `Atom.writable(onSet?)`
### `Atom.named(label)`
### `Atom.unmount()`
---
### `useAtom(atom, selector?)`
### `useAtomState(atom)`
### `useSetAtom(atom)`
## 🚀 Examples
### Counter atom
```ts
import { atom, derive, subscribe } from "@rbxts/charm";
const counterAtom = atom(0);
const doubleCounterAtom = derive(counterAtom, (counter) => counter * 2);
subscribe(doubleCounterAtom, (value) => {
print(value);
});
counterAtom(1);
counterAtom((count) => count + 1);
```
### Counter component
```tsx
import React from "@rbxts/react";
import { useAtom } from "@rbxts/charm";
import { counterAtom } from "./counter-atom";
function Counter() {
const [count, setCount] = useAtom(counterAtom);
return (
setCount(count + 1),
}}
/>
);
}
```
## 🙋 Concerns
In Jotai, `atom()` returns an [atom config](https://jotai.org/docs/core/atom), and its state is managed entirely by the Provider. However, in Charm, `atom()` returns something closer to a store, and its state is managed by the atom itself.
Charm does this for simplicity in use cases outside of React, but this might go against Jotai's focus on pure functional programming. More insight is needed to determine if this is a good idea.
---
Charm is released under the MIT License.
[](LICENSE.md)