API index

Every framework module in the v0.9.1 tree, grouped the way the sidebar groups pages. ChloeKernel.X is ReplicatedStorage.ChloeKernel.X and ChloeKernelServer.X is ServerScriptService.ChloeKernelServer.X. Realm says where a module runs: server, client, or shared (usable on both). A child module that is documented on its parent’s page says so and links there. Specs, benches and the Tests folders are left out. Signatures, defaults and examples live on each module’s page under API.

Workspace

The game layer that src/Server/Bootstrap.luau and src/Client/Bootstrap.luau load between kernel boot and start. Game code lives here; framework modules are used, not edited.

Module	Realm	Page	Purpose
ServerScriptService.Game	server	Overview	Server entry. Builds the channel handles once, injects them as self.Net and registers every service in Registry.
StarterPlayerScripts.Game	client	Overview	Client entry. Builds the channel handles once and registers every controller in Registry.
ReplicatedStorage.Game.Channels	shared	Channels	Every network channel the game uses, declared once with Registry.define and required by both sides.
ServerScriptService.Game.Registry	server	Services and controllers	The list of server services, one require per module in Services. ServiceManager orders boot by Dependencies.
StarterPlayerScripts.Game.Registry	client	Services and controllers	The list of client controllers, one require per module in Controllers.
ServerScriptService.Game.Services.ComponentService	server	Components	Attaches every module in Game.Components as a Mounts handler. Tag an instance CKMount and set MountType to the module name.
StarterPlayerScripts.Game.Controllers.ComponentController	client	Components	The client half: presentation components, mounted in Workspace and the local PlayerGui.
StarterPlayerScripts.Game.Controllers.UIController	client	Screens	Binds each Game.Screens module to the Studio-authored ScreenGui of the same name. open, close, isOpen, modal exclusivity and gamepad selection.

Scaffolding for new services, controllers, screens and components is on Scaffolding.

Kernel

Module	Realm	Page	Purpose
ChloeKernel	shared	Kernel and boot	The microkernel. Kernel.boot once per VM; owns the Scheduler, Hooks, Bus, services, processes, scopes and diagnostics.
ChloeKernelServer	server	Kernel and boot	The server kernel over the shared core: sessions, the NetDriver, the close phase and securityAudit.
ChloeKernel.Scheduler	shared	Scheduler	Priority queues drained under a per-frame budget, with deadlines (after, every) and engine-phase schedulers.
ChloeKernel.Process	shared	Processes	A coroutine with a PID and a lifecycle, stepped by the scheduler. Process.yield() and Process.sleep(seconds).
ChloeKernel.ServiceManager	shared	Services	Dependency-sorted two-phase boot (every init, then every start) and stop in reverse boot order.
ChloeKernelServer.Session	server	Sessions	The per-player lifetime object: bind, bindLast, Data, Profile, ProfilePending, JoinData, ExitReason.
ChloeKernel.Scope	shared	Scope	Owns connections, timer handles, instances, tweens and cleanup callbacks, and releases them in reverse order.
ChloeKernelServer.Milestones	server	Milestones	Once-per-session moments recorded on the session, so Milestones.on replays them to subscribers that arrive late.
ChloeKernel.IPC.Signal	shared	Signal	Point-to-point events with thread reuse and O(1) disconnect.
ChloeKernel.IPC.Bus	shared	Bus	Topic publish and subscribe with trailing wildcards; an optional NetBridge carries marked topics across the network.
ChloeKernel.Hooks.HookRegistry	shared	Hooks	Named hook points with priority-ordered handlers; fail-closed unless a point is defined FailOpen.
ChloeKernel.Logger	shared	Logger	Scoped, leveled logging with pluggable sinks and Logger.capture for tests.
ChloeKernel.GcWatch	shared	GcWatch	Allocation rate, GC cycle cadence and reclaim sizes from sampling gcinfo().
ChloeKernel.ErrorWatch	shared	ErrorWatch	Deduplicated script-error telemetry, published as Kernel.ScriptError.
ChloeKernel.Pool	shared	Pool	Instance reuse for things spawned constantly: bullets, VFX, damage numbers.
ChloeKernel.TablePool	shared	TablePool	Scratch table recycling for per-frame sweeps.
ChloeKernel.Preload	client	Preload	Warms registered assets in batched PreloadAsync calls and reports progress on the Bus.
ChloeKernel.Serde	shared	Serde	Buffer serialization for storage and replication: schema codecs, adaptive encoding and struct deltas.
ChloeKernel.Base64	shared	Base64	Buffer-native Base64 for stores that cannot hold raw buffers; uses EncodingService where the engine has it.
ChloeKernel.Rng	shared	Rng	Deterministic seeded randomness with named forks.
ChloeKernel.Time	shared	Time	One clock surface: now, server, frame and a scaled, pausable game time.
ChloeKernel.Rules	shared	Rules	Declarative automation over Bus topics: where, count, once, cooldown, run.
ChloeKernel.Text	shared	Text	Localization over locale tables, or the player’s Roblox translator with Source = "Translator".
ChloeKernel.Curve	shared	Curve	Piecewise scaling curves as data: XP tables, falloff, prices.
ChloeKernel.TagWatch	shared	TagWatch	CollectionService tag membership limited to instances under a root, Workspace by default.

Networking

Module	Realm	Page	Purpose
ChloeKernelServer.Net	server	NetDriver	Typed channels over Packet. Intents and requests pass a session check, a token bucket and a fail-closed hook chain.
ChloeKernel.Net.Client	client	NetClient	The client half of the NetDriver: intents, states, requests and unreliable state.
ChloeKernel.Net.Registry	shared	Registry	Single-source channel definitions with declarative Validate rules, consumed by both sides.
ChloeKernel.Net.Packet	shared	Packet and wire types	The wire transport, ported from Packet v1.7 by Suphi Kaner with marked local changes.
ChloeKernel.Net.Packet.Types	shared	Packet and wire types	The wire type engine behind Packet and Serde. Child of Packet.
ChloeKernel.Net.Packet.TransportGuard	shared	Packet and wire types	Message-rate and pending-request limits applied before decode or coroutine scheduling. Child of Packet.
ChloeKernel.Net.TokenBucket	shared	Rate limiting	Continuous-refill rate limiter; callers pass the clock.
ChloeKernel.Net.Prediction	client	Prediction	Optimistic client actions that the server acknowledges or rolls back.
ChloeKernelServer.Replica	server	Replica	Server-owned state replicated to interested clients with per-replica tick rates and field deltas.
ChloeKernel.Net.ReplicaClient	client	Replica	Receives replicas by name with the shared schema.
ChloeKernelServer.NetGovernor	server	NetGovernor	Grades each client link Good, Strained or Poor and slows replication to weak links.
ChloeKernel.Net.GovernorClient	client	NetGovernor	The client half of NetGovernor: readiness, probe echoes and the device hint.
ChloeKernelServer.BusBridge	server	BusBridge	Forwards marked Bus topics to clients and accepts whitelisted client publishes as rate-limited intents.
ChloeKernel.Net.BusBridgeClient	client	BusBridge	The client half of BusBridge.
ChloeKernelServer.MessageDriver	server	MessageDriver	Cross-server events over MessagingService, Serde-packed, within the service limits.

Net.Packet.Signal, Net.Packet.Task and the Types children (Characters, Enums, Static1 to Static3) are internal to Packet.

Data

Module	Realm	Page	Purpose
ChloeKernelServer.Data	server	DataDriver	Player data: session locks, migrations, validation, codecs, autosave and fail-closed loads.
ChloeKernelServer.Data.Handoff	server	Handoff	Hands a session lock between servers over MessagingService, with MemoryStore presence. Used by DataDriver through its Handoff config.
ChloeKernelServer.Data.Backends.DataStoreBackend	server	Backends	The default backend: DataStore records written through UpdateAsync only. Child of Data.
ChloeKernelServer.Data.Backends.MemoryBackend	server	Backends	In-process store for specs and Studio. Child of Data.
ChloeKernelServer.Data.Backends.HttpBackend	server	Backends	External database adapter over a REST API with ETag preconditions. Child of Data.
ChloeKernelServer.Data.MemoryDriver	server	MemoryDriver	Cross-server temporary state over MemoryStoreService, with buffer packing and sort keys.

DataDriver features with their own pages: Version history, Backups and Profile snapshots.

Commerce

Module	Realm	Page	Purpose
ChloeKernelServer.Commerce.Receipts	server	Receipts	Developer product grants that are acknowledged only after the grant has saved, deduplicated by a per-profile ledger.
ChloeKernelServer.Commerce.Passes	server	Passes	Game pass ownership per session, looked up once on join and updated by purchases in the server.
ChloeKernelServer.Commerce.Pricing	server	Pricing and Roblox Plus	Each player’s Roblox Plus status on the session, and the Robux each product or pass purchase cost.
ChloeKernel.Prices	client	Pricing and Roblox Plus	The local player’s own price for each configured pass and developer product, read again when Roblox Plus changes.
ChloeKernelServer.Commerce.Transactions	server	Transactions	Durable two-profile trades: prepare both profiles, commit one journal decision, settle both records.
ChloeKernelServer.Data.TransactionRecovery	server	Transaction recovery	Settles a crashed trade from its journal decision before the profile loads. Used by DataDriver.

Security and compliance

Module	Realm	Page	Purpose
ChloeKernelServer.AntiExploit.Movement	server	Movement monitor	Server-side speed and teleport checks over character motion, with strikes and rubberbanding.
ChloeKernelServer.AntiExploit.Rewind	server	Rewind	Lag-compensated hit validation and detection against rewound player capsules.
ChloeKernelServer.AntiExploit.Consequences	server	Consequences	Bans through Players:BanAsync and escalates the duration from each account’s ban history.
ChloeKernelServer.Forensics	server	Forensics	Anti-exploit flight recorder: a rolling movement window frozen into a capture when a violation topic fires.
ChloeKernelServer.Fuzz	server	Fuzz and audit	Hostile-payload sweep over every registered channel. kernel:securityAudit() on the server kernel is its static partner.
ChloeKernelServer.Policy	server	Policy	PolicyService rules per session (paid random items, paid trading, ads), refused until loaded.
ChloeKernelServer.TextFilter	server	TextFilter	Filters player-written text with broadcast or forUser; any error returns nil.

Gameplay systems

Module	Realm	Page	Purpose
ChloeKernelServer.Projectiles	server	Projectiles	Server-authoritative travel-time projectiles; clients receive spawn, redirect, hit and expire packets only.
ChloeKernel.Net.ProjectileClient	client	Projectiles	Pooled client visuals running the same flight math as the server.
ChloeKernelServer.Effects	server	Effects	Buffs and debuffs with durations, stacking, periodic ticks, dispel categories and immunity.
ChloeKernelServer.Zones	server	Zones	Named regions that fire enter and leave for players and tracked entities.
ChloeKernelServer.Senses	server	Senses	Hearing with attunement levels and cone-gated vision, shared by NPCKit and custom agents.
ChloeKernel.Spatial	shared	Spatial	Flat spatial-hash index over ids at world positions.
ChloeKernel.SpatialKit	shared	SpatialKit	Chained spatial queries: a shape, a population, filters and a terminal.
ChloeKernel.Mounts	shared	Mounts	Map-authored attachment points: tag CKMount, set MountType, and a handler mounts it.
ChloeKernelServer.Hazards	server	Hazards	Dynamic annulus danger zones evaluated as distance checks, with a client mirror.
ChloeKernel.Net.HazardClient	client	Hazards	Pooled local rendering for server hazards.
ChloeKernelServer.Sweeps	server	Sweeps	Server-authoritative attack volumes for big rigs, tested as capsules against players.
ChloeKernelServer.Stages	server	Stages	Loads resources when the first player enters a zone and unloads them after the last one leaves.
ChloeKernelServer.Ragdoll	server	Ragdoll	Rig-agnostic ragdolls for classic and AnimationConstraint rigs, with full restore on release.
ChloeKernel.Net.RagdollClient	client	Ragdoll	The owner-side half of Ragdoll: humanoid state, impulses and recovery on the owning client.
ChloeKernelServer.Pathfinding	server	Pathfinding	One handler over grid A*, Theta*, a direct line test and the PathfindingService navmesh, plus followers.
ChloeKernelServer.Matchmaking	server	Matchmaking	Cross-server queues over MemoryStore that reserve a server and teleport each match.
ChloeKernelServer.TeleportRetry	server	TeleportRetry	Teleport tracking and bounded retries shared by Matchmaking and SoftShutdown.
ChloeKernelServer.Leaderboards	server	Leaderboards	Global top-N boards on OrderedDataStores or a custom backend, with queued writes and cached reads.
ChloeKernelServer.Leaderstats	server	Leaderstats	Maps profile and session fields onto the Roblox player list.
ChloeKernelServer.Analytics	server	Analytics	Batched, sampled, rate-capped event pipeline to AnalyticsService or a custom destination.
ChloeKernelServer.LiveConfig	server	LiveConfig	Feature flags and tunables changed without a deploy, from MemoryStore or Experience Configs.
ChloeKernelServer.Settings	server	Player settings	Persisted player preferences behind an allowlisted schema.
ChloeKernel.Net.SettingsClient	client	Player settings	The client half of Settings: cached values and optimistic writes.
ChloeKernelServer.SoftShutdown	server	SoftShutdown	Moves players through a reserved transit server and back on shutdown, and ahead of scheduled restarts.
ChloeKernelServer.ActorPool	server	ActorPool	Parallel Luau worker pool for CPU-bound batches. ExampleWorker and the Worker script are its children.
ChloeKernelServer.Simulation	server	Simulation	Synthetic load modes that drive real kernel code paths. Runs in Studio, or where the ChloeKernelDebug attribute is on.
ChloeKernel.Debug.SimLoad	shared	Simulation	Role-agnostic load rigs built on shared kernel primitives only.
ChloeKernel.Debug.SimPanel	client	Simulation	The SIM CONTROL window that switches server load modes and runs client loads.

The Pathfinding children (AStar, ThetaStar, Direct, RobloxPath, Heap) are required lazily by the handler and are documented on its page.

Kits

Overview: Kits.

Module	Realm	Page	Purpose
ChloeKernelServer.Kits.WeaponKit	server	WeaponKit	Server-validated hitscan weapons as a service.
ChloeKernelServer.Kits.MeleeKit	server	MeleeKit	Server-clocked melee with blocks, guard breaks, parries and combos.
ChloeKernelServer.Kits.SpellKit	server	SpellKit	Mana, cooldowns and channelled casting as a service.
ChloeKernel.MoveKit	shared	MoveKit	Movement abilities gated on movement context; the client executes and MoveKit.server meters.
ChloeKernelServer.Kits.NPCKit	server	NPCKit	NPC lifecycle, per-NPC state and combat, sight, hearing and squad helpers for a game-owned loop.
ChloeKernelServer.Kits.BehaviorTree	server	BehaviorTree	Behavior trees with no internal scheduling; tick one per agent from your loop.
ChloeKernelServer.Kits.InventoryKit	server	InventoryKit	Server-authoritative items: definitions, slotted bags, stacking, equip slots and use handlers.
ChloeKernel.Net.InventoryClient	client	InventoryKit	The client half of InventoryKit: the local player’s bag, kept from boot, with a fetch for screens built later.
ChloeKernelServer.Kits.LootKit	server	LootKit	Weighted loot tables with persisted pity, and Paid tables gated by Policy.
ChloeKernelServer.Kits.CraftingKit	server	CraftingKit	Recipes over InventoryKit, with timed crafts that persist in the profile.
ChloeKernelServer.Kits.ShopKit	server	ShopKit	Soft-currency shops over InventoryKit with deterministic rotating stock.
ChloeKernelServer.Kits.CompanionKit	server	CompanionKit	Owned NPC followers built from NPCKit archetypes.
ChloeKernelServer.Kits.QuestKit	server	QuestKit	Quests as objectives counted off server-published Bus topics.
ChloeKernelServer.Kits.RoundKit	server	RoundKit	An ordered phase cycle with deadlines, minimum-player gates and a replicated countdown.
ChloeKernelServer.Kits.CheckpointKit	server	CheckpointKit	Validated obby checkpoint progression from numbered pads.
ChloeKernelServer.Kits.TeamKit	server	TeamKit	Team assignment, team spawns and friendly-fire vetoes on the combat gates.
ChloeKernelServer.Kits.PartyKit	server	PartyKit	Same-server parties with invites and leaders, following Roblox platform parties.
ChloeKernelServer.Kits.InteractionKit	server	InteractionKit	ProximityPrompts from tags, with every trigger re-validated on the server.
ChloeKernelServer.Kits.ProceduralKit	server	ProceduralKit	Server-authoritative runtime geometry on ProceduralModels. ExampleGenerator is its sample child.
ChloeKernelServer.Kits.AchievementKit	server	AchievementKit	Persisted achievements counted off Bus topics, with optional platform badges.
ChloeKernel.CameraKit	client	CameraKit	Camera shots as data: static, follow, orbit and rail, with blends and cuts.
ChloeKernel.CutsceneKit	shared	CutsceneKit	Cutscenes as timelines; the server sends one packet and every client plays the scene.
ChloeKernelServer.Kits.DialogueKit	server	DialogueKit	Server-authoritative conversation trees with gated choices.
ChloeKernel.MaterialKit	client	MaterialKit	Erodes and restores a real mesh surface face by face over EditableMesh.

Client and media

Module	Realm	Page	Purpose
ChloeKernel.InputDriver	client	InputDriver	Named actions over ContextActionService for keyboard, gamepad and touch, published on the client Bus.
ChloeKernel.AnimKit	shared	AnimKit	Registered animations played through per-rig controllers, with crossfade groups and IK.
ChloeKernel.AudioKit	shared	AudioKit	Client audio engine over bus SoundGroups; AudioKit.server broadcasts server-triggered plays.
ChloeKernel.BonePhysics	client	BonePhysics	Verlet-chain secondary motion for hair, capes and tails.
ChloeKernel.HairKit	shared	HairKit	Generates a skeleton for boneless hair over EditableMesh; HairKit.server rigs once on the server.
ChloeKernel.Dissolve	client	Dissolve	Voxel dissolve, restructure and morph effects.
ChloeKernel.MeshSource	shared	MaterialKit	has(meshPart) and content(meshPart): where a MeshPart’s mesh comes from, read the same way by HairKit, MaterialKit and Dissolve.
ChloeKernel.DeviceBench	client	DeviceBench	A short device benchmark that sets quality budgets, and a governor that holds the frame target.
ChloeKernel.VfxSuite	shared	VfxSuite	Timed VFX sequences; the server sends one packet and every client runs the sequence.
ChloeKernel.Impact	client	Impact	Camera shake, audio ducking and post effects scaled by distance to the event.
ChloeKernel.Gait	client	Gait	Procedural foot planting and body tilt for big rigs.
ChloeKernel.Highlights	client	Highlights	One shared Highlight manager per client that stays under the engine’s 255 limit.

Tooling

Module	Realm	Page	Purpose
ChloeKernel.TestKit	shared	TestKit	The spec runner: describe, it, expect and T.expectWarning.
ChloeKernel.TestKit.Expect	shared	TestKit	Assertion matchers. Child of TestKit.
ChloeKernel.TestKit.Watch	shared	TestKit	Holds Logger warnings and uncaught spec errors per test and fails the test on anything unexpected. Child of TestKit.
ChloeKernel.TestKit.Gate	shared	Spec gate	One serializable spec, audit and fuzz report; ends plugin harness sessions with EndTest.
ChloeKernel.TestKit.Bench	shared	Bench	Microbenchmarks reporting ops per second and p50/p99 latency.
ChloeKernel.Debug.Panel	client	Debug panels	The F8 overlay: CLIENT and SERVER windows with scheduler, frame, memory and network stats.
ChloeKernel.Debug.NetPanel	client	Debug panels	The NET window: a live inspector for kernel channel traffic from both machines.
ChloeKernel.Debug.NetTap	shared	Debug panels	Passive recorder for kernel network traffic that feeds the NET window.
ChloeKernel.Debug.HookScope	shared	Debug panels	The HOOKS window: fire rates, rejections and cost for every hook point.
ChloeKernel.Debug.ImGui	client	Debug panels	Immediate-mode UI for the debug overlays only.
ChloeKernel.Debug.Chronicle	shared	Chronicle	Flight recorder for Bus publishes and hook verdicts, searchable by topic or predicate.

Repository tools are scripts, not modules: tools/check.py (Check), tools/directives.py (Directives), tools/engine.py (Engine reference), tools/regressions/*.py (Regression runners), tools/scaffold.py (Scaffolding) and tools/vendor.py (Releases and vendoring).