DataService

https://leifstout.github.io/dataService/docs/

Admin

DataService is a Roblox library that provides a simple way to manage player data on the server while...

Tokens:510

Snippets:10

Trust Score:9.7

Update:5 months ago

Show doc for...

Tokens:

Raw

### Update Player Data on the Server

Source: https://leifstout.github.io/dataService/docs/intro

Mutate player data on the server when game logic changes player values. This example adds currency upon reward completion.

```lua
-- Example: add currency when a player completes a reward
DataService:update(player, "currency", function(current)
	return current + 100
end)

```

--------------------------------

### Initialize, Read, and Subscribe to Data Changes on the Client

Source: https://leifstout.github.io/dataService/docs/intro

Use the client module to initialize DataService, read player data, and subscribe to changes.

```lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local DataService = require(Packages.DataService).client

DataService:init()

local currency = DataService:get("currency")
print("Currency:", currency)

DataService:getChangedSignal("currency"):Connect(function(newValue)
	print("Currency updated:", newValue)
end)

```

--------------------------------

### Initialize DataService on the Server

Source: https://leifstout.github.io/dataService/docs/intro

In a server script, initialize DataService once with your data template.

```lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local DataService = require(Packages.DataService).server
local DataTemplate = require(Path.To.DataTemplate)

DataService:init({
	template = DataTemplate,
})

```

--------------------------------

### Define Default Player Data Template

Source: https://leifstout.github.io/dataService/docs/intro

Create a module for your default player data. Ensure values are JSON-compatible.

```lua
return {
	currency = 0,
	level = 1,
	 xp = 0,
	inventory = {},
	settings = {
		musicVolume = 0.5,
		sfxVolume = 0.5,
	},
}

```

--------------------------------

### Add DataService Dependency to wally.toml

Source: https://leifstout.github.io/dataService/docs/intro

Add DataService to your project's dependencies in the wally.toml file.

```toml
[dependencies]
DataService = "leifstout/dataservice@1.0.0"

```

Tokens:

Raw