MarcSync Client

Appearance

Return to top
On this page

INFO

MarcSync V0.3 is currently within pre-release which means that there might be unexpected bugs and errors. If you find any bugs or errors please report them within the Discord Server

MarcSync Client V0.3

Welcome to the Documentation page for MarcSync Client V0.3. This page will be updated as the project progresses.

About

MarcSync Client is a client for the MarcSync API. It is a simple, easy to use, and easy to install client that allows you to Store your Data within MarcSync.

Installation

INFO

In order to install MarcSync you will need to join the Discord Server and download the latest version of the client from the #releases channel as well as also creating an API Management Account on the MarcSync Management Panel.

Step 1 - Downloading the Client & putting it into your Game

DANGER

Make Sure to install MarcSync within a Server-Sided and ONLY Server readable Location. This will prevent your Token from being leaked and possible Data Lost.

  • Open the Experience/Game within Roblox Studio where you want to install the MarcSync Client into.
  • Navigate to the Folder where you've downloaded the MarcSync Client into.
  • Drag the MarcSyncv(X.X.X).rbxm file into the Explorer and put the Folder into ServerScriptService.

Step 2 - Configuring the Client

  • Open the MarcSyncv(X.X.X) ModuleScript within the Folder. (ServerScriptService > MarcSync > MarcSyncv(X.X.X))
  • Configure the tokens Table within that Script by doing as following:
    • Replace myNewSuperToken with anything you want. This will be used to identify the Token within the Script(s).
    • Replace myNewSuperTokenSecret with the Token you've created on the MarcSync Management Panel for the Database you'd like to work with.
lua
local tokens = {
    ["myNewSuperToken"] = "myNewSuperTokenSecret"
}

Step 3 - Using the Client

DANGER

Make Sure that you NEVER interact/use or attempt to interact/use MarcSync within a not server-sided or Client readable Script. This will prevent your Token from being leaked and possible Data Lost.

  • To use the Client within your Script you will need to require the MarcSyncv(X.X.X) ModuleScript.
  • After requiring the ModuleScript you will need to create a new Instance of the Client. (Replace myNewSuperToken with how you've named your Token within the tokens Table)
lua
local MarcSync = require(game.ServerScriptService.MarcSync["MarcSyncv(X.X.X)"])
local Client = MarcSync.new("myNewSuperToken")
  • In order to test if you've set up everything correctly, you can try getting the current version of the Client by doing the following:
lua
local MarcSync = require(game.ServerScriptService.MarcSync["MarcSyncv(X.X.X)"])
local Client = MarcSync.new("myNewSuperToken")

print(Client.request.version:get())
/*{
    ["success"] = true,
    ["updateServer"] = "https://discord.gg/pyysgrUeYE",
    ["version"] = "0.3.0"
}*/