Skip to content

README.md

Latest commit

 

History

History
55 lines (38 loc) · 1.22 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.22 KB
Raw

UserVault Logo

UserVault

UserVault is a DataStore module built on ProfileStore which provides safe access to player data.

Getting Started

Install

Add UserVault to your Wally packages:

rodrick160/uservault@0.5.0

Setup

UserVault needs to be started before it can be used. It is important to start UserVault before any dependent modules. If you are using Knit or an equivalent system, start UserVault before starting Knit.

Example

local Knit = require(game.ReplicatedStorage.Packages.Knit)
local UserVault = require(game.ReplicatedStorage.Packages.UserVault)

UserVault.Start {
	PlayerDataTemplate = {
		Version = 1,
		Shared = {
			Coins = 0
		},
		Server = {}
	}
}

-- Require modules

Knit.Start():catch(warn)

Docs

Credit

Authors

  • Sebastian Seifert

Third-Party Packages