Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/littensy/charm-example
🍀 Use Charm to build a Roblox game
https://github.com/littensy/charm-example
roblox roblox-ts
Last synced: 11 days ago
JSON representation
🍀 Use Charm to build a Roblox game
- Host: GitHub
- URL: https://github.com/littensy/charm-example
- Owner: littensy
- License: mit
- Created: 2024-08-05T01:44:29.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T02:39:49.000Z (2 months ago)
- Last Synced: 2024-10-27T03:35:03.139Z (2 months ago)
- Topics: roblox, roblox-ts
- Language: TypeScript
- Homepage: https://roblox.com/games/18805522597
- Size: 31.3 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## 🍀 Charm Example
An example project demostrating how to use [Charm](https://github.com/littensy/charm) to build a Roblox game. This includes [syncing server state](src/shared/store/sync) and an implementation of [filtering player data](src/shared/store/sync/utils/filter-payload.ts).
**The libraries in this project include:**
- 🍀 [Charm](https://github.com/littensy/charm): Atomic state management
- 🧪 [Jest](https://jsdotlua.github.io/jest-lua): Testing framework ported to roblox-ts
- 🖥️ [Vide](https://centau.github.io/vide): Cutting-edge UI library
- 💎 [Lapis](https://nezuo.github.io/lapis): Immutable data store abstraction
[Check out the game →](https://www.roblox.com/games/18805522597/)
### 🚀 Getting Started
```bash
# 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:
>
> ```bash
> sh bin/jest-flag.sh
> ```
To run your unit tests, start a playtest session in [Run Mode](https://create.roblox.com/docs/studio/testing-modes#playtest-options) (`F8`).
---
This project is released under the MIT License.
[](LICENSE.md)