{"id":"riptide/core","name":"core","scope":"riptide","platform":"roblox","description":"A strict Luau framework for Roblox with side-specific APIs, typed networking/state, module lifecycle orchestration, and sandboxed plugins.","version":"0.9.0-maelstrom.2","latest":"0.9.0-maelstrom.2","versions":["0.9.0-maelstrom.1","0.9.0-maelstrom.2"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"0d339fed50618d0ecd51db6441f45a61bd5e83b6908cbcbbf439fdfe79ff036b","likes":0,"downloads":0,"install":"forest install riptide/core","url":"https://forest.dev/p/roblox/riptide/core","files":"https://api.forest.dev/ai/package/roblox/riptide/core/files","readme":"
\n\n\"Riptide\n\n
\n\n\"GitHub\n\"Documentation\"\n\"GitHub\n\"Changelog\"\n\"Pesde\n\"Wally\n\"Tests\"\n\n
\n
\n\nRiptide was built from the ground up for production Roblox games. It solves the most common architecture problems while remaining invisible, staying out of your way, and scaling elegantly.\n\n
\n\n> [!WARNING]\n> **๐ŸŒŠ Maelstrom Build โ€” Unstable**\n>\n> You are on the **Maelstrom** pre-release channel (`0.9.0-maelstrom.2`). Maelstrom is Riptide's unstable development branch โ€” it ships on a separate Git branch, is **not production-tested**, and APIs may change without notice. If you need stability, pin a [stable release](https://github.com/riptide-project/framework/releases).\n\n---\n\n## โœจ Key Features\n\n- ๐Ÿ“… **Deterministic Lifecycle:** Phased initialization (`Load` โ†’ `Init` โ†’ `Start`) ensures modules and plugins load in a predictable, race-free order.\n- ๐Ÿ”Œ **Framework-Layer Plugins:** Sandboxed plugins load before game modules, reach bounded `Start` readiness before gameplay starts, support dependency ordering, and stay isolated so third-party failures cannot bring down the framework.\n- โšก **Zero-Allocation Signals:** A synchronous linked-list signal dispatcher with zero scheduler overhead and no per-fire thread creation.\n- ๐Ÿ“ก **Unified Networking:** Multiplexed `RemoteEvent` and `UnreliableRemoteEvent` networking with flat, closure-free middleware chains.\n- ๐Ÿ›ก๏ธ **Typed Remote Validation:** Enforce client payload types at the network boundary via `Riptide.Network.RegisterTyped()` in server modules and composable `Guard` validators.\n- ๐Ÿ“ฆ **100% Strict Luau:** Written entirely with `--!strict`, exporting clean API interfaces for full autocomplete and type-checking.\n- ๐Ÿ› ๏ธ **Built-in Power:** Ships with Sleitnick's `Trove` resource tracker, `EventBus` pub/sub, `Guard` schema validators, `StateMachine`, `Async` utilities, and server-authoritative `State` replication.\n\n---\n\n## ๐Ÿ“ฆ Installation\n\n### Via Pesde (Recommended)\n\n```bash\npesde add riptide/core\n```\n\n### Via Wally\n\n```toml\n[dependencies]\nRiptide = \"riptide/core@0.9.0-maelstrom.2\"\n```\n\n### Manual (.rbxm)\n\nDownload `Riptide.rbxm` from the [Releases](https://github.com/riptide-project/framework/releases) page and place it inside `ReplicatedStorage`.\n\n---\n\n## ๐Ÿ Quick Look\n\nRiptide organizes your game logic into **Services** (server) and **Controllers** (client). Each module follows a clean lifecycle: modules are loaded first, `Init` runs synchronously, and `Start` runs asynchronously afterward.\n\n```lua\n-- ServerScriptService/Services/CoinsService.lua\n--!strict\nlocal CoinsService = {}\n\nfunction CoinsService:Init(Riptide)\n -- Init runs synchronously. Register network handlers and grab\n -- references to other services here โ€” everything is loaded but\n -- not yet started.\n Riptide.Network.RegisterTyped(\"BuyItem\", {\n Riptide.Guard.String(50), -- itemId: string, max 50 chars\n Riptide.Guard.Number(0, 1000), -- price: number, 0โ€“1000\n }, function(player, itemId, price)\n print(player.Name .. \" bought \" .. itemId .. \" for \" .. price .. \" coins\")\n end)\nend\n\nfunction CoinsService:Start(Riptide)\n -- Start runs in its own coroutine โ€” safe to yield here.\n self.Trove = Riptide.Trove.new()\n print(\"CoinsService is running!\")\nend\n\nfunction CoinsService:OnPlayerAdded(Riptide, player)\n Riptide.State:SetForPlayer(player, \"coins\", 0)\nend\n\nreturn CoinsService\n```\n\n**Launch the server** from a server script:\n\n```lua\n-- ServerScriptService/main.server.lua\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\nlocal ServerScriptService = game:GetService(\"ServerScriptService\")\nlocal Riptide = require(ReplicatedStorage.Packages.Riptide).Server\n\nRiptide.Launch({\n ModulesFolder = ServerScriptService.Services,\n})\n```\n\n**Launch the client** from a LocalScript:\n\n```lua\n-- StarterPlayerScripts/main.client.lua\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\nlocal Players = game:GetService(\"Players\")\nlocal Riptide = require(ReplicatedStorage.Packages.Riptide).Client\n\nRiptide.Launch({\n ModulesFolder = Players.LocalPlayer.PlayerScripts.Controllers,\n})\n```\n\n---\n\n## ๐Ÿงช Testing Architecture\n\nRiptide ships with a **Hybrid Testing Architecture** built on [`frktest`](https://github.com/itsfrank/frktest):\n\n- **CI / Development:** 100+ unit and integration tests run via [Lune](https://github.com/lune-org/lune) CLI in milliseconds โ€” no Studio required.\n- **Engine Integration:** The exact same suites compile and run inside a real Roblox DataModel for true Client/Server replication validation.\n\n```bash\nlune run test/lune/RunLuneTests.luau\n```\n\n---\n\n## ๐Ÿ“š Documentation\n\nComplete setup guides, API reference, and examples:\n\n**[๐Ÿ‘‰ Riptide Documentation](https://riptide-project.github.io/framework)**\n\n---\n\n## ๐Ÿ“„ License\n\nMIT โ€” see [LICENSE](LICENSE).\n","readmeTruncated":false}