Skip to main content
Version: Next

Introduction

Shard is a customizable, single-file, controller-service oriented, and object-oriented framework that supports functional programming. It comes with ProfileStore and Replica integrated by default, enabling seamless data persistence and real-time replication.

Using the Shard plugin, you can spin up a fully functional server-client architecture in seconds, with built-in data and replication systems that scale easily.

Shard is built with simplicity and flexibility in mind, it reduces boilerplate and improves development speed, letting you focus on creating polished gameplay experiences without getting bogged down by infrastructure code.

🔧 Notable Features​

  • Single-file architecture

  • Object-Oriented modules using .new() constructors

  • Built-in ProfileStore and Replica

    • Automatic session handling and reconciliation
    • Global update support (e.g. for gifting systems)
    • Safe Developer Product processing via ProfileStore's best practices
    • Player data managed through a custom PlayerProfile class

  • SimpleNet

    • Easy-to-use abstraction over RemoteEvent, RemoteFunction, BindableEvent, and BindableFunction
    • Supports FireAll, FireAllExcept, FireFilter, FireDelayed, and more

  • Dispatcher

    • Internal publish/subscribe event system
    • Enables communication between services, controllers, or other game systems

  • GetModule

    • Lightweight dependency registry
    • Access any registered object-oriented module by name
    • Automatically falls back to searching ReplicatedStorage or ServerStorage if missing

  • Packages Repository

    • Shard has a central repository for commonly used and useful packages
    • Easily install and update packages from the repository using the Shard plugin

  • Modular & Customizable

    • Shard doesn't force you to use services, controllers, or even OOP
    • Any ModuleScript can be loaded and integrated into the system

In this documentation, we'll walk you through how to install and use Shard, from setting up your project to managing networking, player data, and game systems.

Let's get started! Click next to learn how to install Shard.