🍀 Charm Example

An example project demostrating how to use Charm to build a Roblox game. This includes syncing server state and an implementation of filtering player data.

The libraries in this project include:

• 🍀 Charm: Atomic state management
• 🧪 Jest: Testing framework ported to roblox-ts
• 🖥️ Vide: Cutting-edge UI library
• 💎 Lapis: Immutable data store abstraction

Check out the game →

🚀 Getting Started

# Clone this repository
git clone https://github.com/littensy/charm-example.git
cd charm-example

# Install dependencies
pnpm install

# Build a place file
pnpm compile
pnpm build

🧪 Running Tests

Note

Jest Lua depends on debug.loadmodule (FFlagEnableLoadModule) to run tests.

On MacOS, you can run the following command to enable this feature:

sh bin/jest-flag.sh

To run your unit tests, start a playtest session in Run Mode (F8).

---

This project is released under the MIT License.