How littensy/charm works
Project type and purpose
• This repo is a multi-package monorepo for Roblox-TS libraries (using pnpm + wally).
• Its core package “charm” provides atomic state management primitives (atom, computed, subscribe, effect, etc.).
• Three companion packages extend charm:
• “charm-sync” (server-client synchronization via remote events)
• “react-charm” (React hooks for charm: useAtom)
• “vide-charm” (Vide data sources for charm: useAtom)
• There are build scripts (bin/*.sh), CI workflows (.github/workflows), tests under tests/, and configuration for ESLint, Prettier, Selene, stylua.
File structure
• Top level: repo-wide config (.eslintrc, .prettierrc, tsconfig.json, wally/rokit/testez configs), pnpm workspace config.
• packages/ folder: four sibling packages, each with:
• default.project.json + wally.toml (Luau packaging)
• package.json (npm metadata)
• src/ (Luau code + .d.ts definitions)
• modules/: holds external (wally-installed) dependencies.
• bin/: shell scripts orchestrating build, test, install.
• tests/: per-package unit tests (testez), benchmarks, utils.
• .github/workflows/: CI for build/test and release.
README for additional insights
• Detailed API reference for core functions (atom, subscribe, effect, computed, observe, mapped, peek, batch).
• Sections on React and Vide bindings show how charm integrates with UI.
• “Charm Sync” section describes server/client sync flows: patches, hydration, remote events.
• Emphasizes Luau (Roblox scripting language) and Roblox-TS ecosystem.