riptide/core

---

✨ Key Features

• 📅 Deterministic Lifecycle: Phased initialization (Load → Init → Start) ensures modules and plugins load in a predictable, race-free order.
• 🔌 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.
• ⚡ Zero-Allocation Signals: A synchronous linked-list signal dispatcher with zero scheduler overhead and no per-fire thread creation.
• 📡 Unified Networking: Multiplexed RemoteEvent and UnreliableRemoteEvent networking with flat, closure-free middleware chains.
• 🛡️ Typed Remote Validation: Enforce client payload types at the network boundary via Riptide.Network.RegisterTyped() in server modules and composable Guard validators.
• 📦 100% Strict Luau: Written entirely with --!strict, exporting clean API interfaces for full autocomplete and type-checking.
• 🛠️ Built-in Power: Ships with Sleitnick's Trove resource tracker, EventBus pub/sub, Guard schema validators, StateMachine, Async utilities, and server-authoritative State replication.

---

📦 Installation

Via Pesde (Recommended)

pesde add riptide/core

Via Wally

[dependencies]
Riptide = "riptide/[email protected]"

Manual (.rbxm)

Download Riptide.rbxm from the Releases page and place it inside ReplicatedStorage.

---

🏁 Quick Look

Riptide 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.

-- ServerScriptService/Services/CoinsService.lua
--!strict
local CoinsService = {}

function CoinsService:Init(Riptide)
    -- Init runs synchronously. Register network handlers and grab
    -- references to other services here — everything is loaded but
    -- not yet started.
    Riptide.Network.RegisterTyped("BuyItem", {
        Riptide.Guard.String(50),       -- itemId:  string, max 50 chars
        Riptide.Guard.Number(0, 1000),  -- price:   number, 0–1000
    }, function(player, itemId, price)
        print(player.Name .. " bought " .. itemId .. " for " .. price .. " coins")
    end)
end

function CoinsService:Start(Riptide)
    -- Start runs in its own coroutine — safe to yield here.
    self.Trove = Riptide.Trove.new()
    print("CoinsService is running!")
end

function CoinsService:OnPlayerAdded(Riptide, player)
    Riptide.State:SetForPlayer(player, "coins", 0)
end

return CoinsService

Launch the server from a server script:

-- ServerScriptService/main.server.lua
local ReplicatedStorage  = game:GetService("ReplicatedStorage")
local ServerScriptService = game:GetService("ServerScriptService")
local Riptide = require(ReplicatedStorage.Packages.Riptide).Server

Riptide.Launch({
    ModulesFolder = ServerScriptService.Services,
})

Launch the client from a LocalScript:

-- StarterPlayerScripts/main.client.lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Players = game:GetService("Players")
local Riptide = require(ReplicatedStorage.Packages.Riptide).Client

Riptide.Launch({
    ModulesFolder = Players.LocalPlayer.PlayerScripts.Controllers,
})

---

🧪 Testing Architecture

Riptide ships with a Hybrid Testing Architecture built on frktest:

• CI / Development: 100+ unit and integration tests run via Lune CLI in milliseconds — no Studio required.
• Engine Integration: The exact same suites compile and run inside a real Roblox DataModel for true Client/Server replication validation.

lune run test/lune/RunLuneTests.luau

---

📚 Documentation

Complete setup guides, API reference, and examples:

👉 Riptide Documentation

---

📄 License

MIT — see LICENSE.