# Flux

> A lightweight, strictly typed buffer-serialized networking library for Roblox.

## Docs

- [Client](https://flux-docs.com/api/client.md): The client-side event object returned by Flux.Client.
- [Flux](https://flux-docs.com/api/flux.md): The root module: two constructors, two exported types, one namespace.
- [Bridge](https://flux-docs.com/api/internals/bridge.md): The internal batching and flush layer.
- [Buffers](https://flux-docs.com/api/internals/buffers.md): The internal encoding layer: pooled writers, readers, and every read and write pair.
- [Remotes](https://flux-docs.com/api/internals/remotes.md): Resolution and caching of the two underlying remote instances.
- [Server](https://flux-docs.com/api/server.md): The server-side event object returned by Flux.Server.
- [Types](https://flux-docs.com/api/types.md): The schema constructor namespace: every factory Flux.Types exposes.
- [Composite Types](https://flux-docs.com/api/types/composites.md): Optional, Array and Struct: wrapping other types into structured payloads.
- [Number Types](https://flux-docs.com/api/types/numbers.md): Fixed-width integer and float schema constructors.
- [Primitive Types](https://flux-docs.com/api/types/primitives.md): Booleans, strings, and the dynamic escape hatch.
- [Roblox Datatypes](https://flux-docs.com/api/types/roblox.md): Schema constructors for vectors, CFrames, colours, instances and enums.
- [Architecture](https://flux-docs.com/concepts/architecture.md): The seven modules that make up Flux, and the path a single Fire takes.
- [Batching](https://flux-docs.com/concepts/batching.md): Every send accumulates into a shared buffer and flushes once per frame.
- [Serialization](https://flux-docs.com/concepts/serialization.md): How Flux turns Luau values into bytes, with and without a schema.
- [Packets](https://flux-docs.com/concepts/wire-format/packets.md): The framing Flux uses inside every buffer it sends.
- [Type Tags](https://flux-docs.com/concepts/wire-format/type-tags.md): The tag byte table used by the dynamic encoder, with per-type sizes.
- [Connections](https://flux-docs.com/guides/connections.md): Disconnecting listeners, and the cleanup Flux does not do for you.
- [Events](https://flux-docs.com/guides/events.md): Firing and listening: reliable, unreliable, targeted and broadcast.
- [Generics](https://flux-docs.com/guides/generics.md): Type your events so Fire, Connect and Invoke autocomplete correctly.
- [Invocations](https://flux-docs.com/guides/invocations.md): Client-to-server round trips with return values, error propagation and timeouts.
- [Schemas](https://flux-docs.com/guides/schemas.md): Declare a fixed wire layout to drop type tags and narrow number widths.
- [Shared Modules](https://flux-docs.com/guides/shared-modules.md): Using Flux from code that runs on both the server and the client.
- [Flux](https://flux-docs.com/index.md): A lightweight, strictly typed networking library for Roblox, built on buffer serialization.
- [Installation](https://flux-docs.com/installation.md): Add Flux to your place and confirm it loads on both the server and the client.
- [Quickstart](https://flux-docs.com/quickstart.md): Send events in both directions and make your first client-to-server invocation.
- [Known Limits](https://flux-docs.com/reference/limits.md): Constraints, sharp edges and behaviour worth knowing before you ship.
- [Migrating](https://flux-docs.com/reference/migrating.md): Moving to Flux from raw remotes or a Warp-style API.
- [Supported Types](https://flux-docs.com/reference/supported-types.md): Every value Flux can serialize, and everything it cannot.