yTrev/Replion

Replion is a module that allows the replication of information from Server to Client lightly and efficiently.

Installation

Wally

Add Replion as a dependency to your wally.toml file:

Replion = "ytrev/replion@2.0.0-rc.3"

Usage

A simple example that shows how to use Replion.

Server

local ReplicatedStorage = game:GetService('ReplicatedStorage')
local Players = game:GetService('Players')

local Replion = require(ReplicatedStorage.Packages.Replion)
local ReplionServer = Replion.Server

type DataReplion = Replion.ServerReplion<{
	Coins: number,
}>

local function createReplion(player: Player)
	ReplionServer.new({
		Channel = 'Data',
		ReplicateTo = player,

		Data = {
			Coins = 0,
		}
	})
end

Players.PlayerAdded:Connect(createReplion)

for _, player: Player in Players:GetPlayers() do
	task.spawn(createReplion, player)
end

while true do
	for _, player: Player in Players:GetPlayers() do
		local playerReplion: DataReplion? = ReplionService:GetReplionFor(player, 'Data')
		if playerReplion then
			playerReplion:Increase('Coins', 10)
		end
	end

	task.wait(1)
end

Client

local ReplicatedStorage = game:GetService('ReplicatedStorage')

local Replion = require(ReplicatedStorage.Packages.Replion)
local ReplionClient = Replion.Client

ReplionClient:AwaitReplion('Data', function(dataReplion)
	print('Coins:', dataReplion:Get('Coins'))

	local connection = dataReplion:OnChange('Coins', function(newCoins: number, _oldCoins: number)
		print('Coins:', newCoins)
	end)
end)