ReplicatedRegistry | Simple state-synchronized table registry

[athar_adv (athar_adventure)]

ReplicatedRegistry is a module I made that you can very easily use to sync table changes between server and client (or vice versa).

It is a single module with 0 dependencies, unlike charm-sync or Replica, and it is very easy to use.

Documentation

1. ReplicatedRegistry.SetTable(registerKey: any, tbl: T?, filter: ((sender: Player?, key: any, value: any, path: {any}) -> boolean)?) -> T
   
   
   • Registers the table into the module so that it is subject to replication signals from the other side.
     
     If a filter is specified, if a specific change does not pass the filter it is rejected (aka when the filter returns false). (This is on a per key-value pair basis.)
     If the change should be accepted, the filter should return true.
     Note that if the change was sent from the server, sender is always nil.
     
     
2. ReplicatedRegistry.GetTable(registerKey: any): Table?
   
   
   • Retrieves a registered table using its key, or nil if not found.
     
     
3. ReplicatedRegistry.WaitForTable(registerKey: any, timeOut: number?): Table?
   
   
   • Waits timeOut or math.huge seconds until the table with the specified key is found, then that table is returned.
     
     
4. ReplicatedRegistry.SendChanges(replicationMode: "ToClient"|"ToAllClients"|"ToServer", registerKey: any, player: Player?, unreliable: boolean?)
   
   
   • Sends all changes (since SendChanges/SetTable was last called) to the side specified by replicationMode.
     If replicationMode is “ToClient”, then the player argument is required.
     If unreliable is passed as true, then the function will replicate changes via the unreliable changed remote event instead of the normal one.
     
     
5. ReplicatedRegistry.RequestTable(registerKey: any): Table?
   
   
   • A client-only function that requests the table associated with registerKey from the server. Returns nil if rejected, the requested table if else.
     
     
6. ReplicatedRegistry.OnRecieve(registerKey: any, fn: (sender: Player?, tbl: Table) -> ()): () -> ()
   
   
   • Sets a callback function to be called when a replication signal for the registerKey is sent to this side.
     Returns a function to disconnect the callback.
     
     
7. ReplicatedRegistry.SetOnRequest(fn: (player: Player, registerKey: any) -> boolean)
   
   
   • A server-side function to set the filter for ReplicatedRegistry.RequestTable calls.
     By default, this filter only accepts RequestTable requests if the key matches/is the player’s UserId.
     However, the purpose of this function is so you can change that.
     
     
8. ReplicatedRegistry.GetFilter(nameToArgs: FilterList): Filter
   
   
   • Returns a composite filter containing all filters specified within nameToArgs.
     The returned filter can be used in ReplicatedRegistry.SetTable()

Examples

The following example demonstrates simple player data replication between clients and the server.

Server:

local ReplicatedRegistry = require(path.to.module)
local setTbl = ReplicatedRegistry.SetTable
local replicate = ReplicatedRegistry.SendChanges
local filters = ReplicatedRegistry.Filters

-- A filter that rejects all replication requests from the client
local norecv = filters.NoReceive(true)

game.Players.PlayerAdded:Connect(function(plr)
	local tbl = {
		JoinTime = os.time(),
		Kills = 0
	}
	setTbl(plr.UserId, tbl, norecv)
	
	tbl.Kills = 10
	replicate("ToClient", plr.UserId, plr)
end)

Client:

local player = game.Players.LocalPlayer

local ReplicatedRegistry = require(path.to.module)
local setTbl = ReplicatedRegistry.SetTable
local request = ReplicatedRegistry.RequestTable
local filter = ReplicatedRegistry.GetFilter {
   DontAcceptIfNil = true,
   RateLimit = 10
}

local tbl = setTbl(player.UserId, request(player.UserId), filter)
while task.wait(1) do
	print(tbl.Kills) -- 10
	print(tbl.JoinTime) -- Some big number
end

Download ReplicatedRegistry →
ReplicatedRegistry.rbxm (7.4 KB)