core_ztzbx for ZTZBX Framework

Requirements

• language
• fivem-mysql

To build it, run build.cmd. To run it, run the following commands to make a symbolic link in your server data directory:

cd /d [PATH TO THIS RESOURCE]
mklink /d X:\cfx-server-data\resources\[local]\core-ztzbx dist

Afterwards, you can use ensure core-ztzbx in your server.cfg or server console to start the resource.

Guide

---

In your script you need to add the dependency in the fxmanifest.lua

dependencies {
    "core-ztzbx"
}

How the Auth works

This is not the best way to do it, but is pretty safe, if you got some ideas to make it more safe, just get in touch with me.

graph TD;
    Client-->SendLoginPetitionToServer-->Server-->AuthProcess-->Authorized;
    AuthProcess-->NotAuthorized-->ReturnErrorToClient;
    Authorized-->CreatingSession
    Authorized-->AddingPlayerOnlineList
    Authorized-->GeneratingToken
    Authorized-->GeneratingPlayerUtils
    GeneratingToken-->ReturnTokenToClient

Loading

Client Side

Send Message on concret User Chat

Exports["core-ztzbx"].sendOnUserChat("Your chat message");

Get The Player Token

This will be fundamental to make interactions with the database

string token = Exports["core-ztzbx"].playerToken();

Ban Player

To ban a player you need to be in the admin group

string token = Exports["core-ztzbx"].banPlayer("playerUsername");

Get Player Username

To ban a player you need to be in the admin group

string username = Exports["core-ztzbx"].playerUsername();

Server Side

Send Message on concret User Chat

int source_id = Player.id;
Exports["core-ztzbx"].sendOnUserChat(source_id, "Your chat message");

Login

This will be use to login a user in the server, return a string.

// this is the player id
int source_id = Player.id;

string username = "user";
string password = "pas1234";

List<string> user_pass = new List<string> {};

// first the username and after the password
user_pass.Add(username);
user_pass.Add(password);

string result = Exports["core-ztzbx"].login(source_id, user_pass);

if (result == "OK")
{
    // your process
}
else 
{
    Debug.WriteLine(result);
}

Register player

This will be use to register a user in the server, return a string.

// this is the player id
int source_id = Player.id;

string username = "user";
string password = "pas1234";
string email = "[email protected]";

List<string> user_pass = new List<string> {};

// add the credentials in the exact order
user_pass.Add(username);
user_pass.Add(password);
user_pass.Add(email);

string result = Exports["core-ztzbx"].register(source_id, user_pass);

if (result == "OK")
{
    // your process
}
else 
{
    Debug.WriteLine(result);
}

Get the Player token

// this is the player id
int source_id = Player.id;

// if token return "" thats mean the user isn't logged.
string token = Exports["core-ztzbx"].playerToken(source_id);

Check if the user is admin

This will return a bool

// the idea is to do this with a event in the server side ho need the client token
// and another event in the client si ho got triggered from here to indicate if the user got pers to do an concret action.

// in this example i dont use the event i just call the exported event from the server side, but this is not the way to do it, is just an example.
string token = Exports["core-ztzbx"].playerToken(source_id);

bool isAdmin = Exports["core-ztzbx"].playerAdmin(token);

if (isAdmin())
{
    // trigger your event
}
else
{
    // trigger your event
}

Get all Players usernames

This will return a IEnumerable

// pretty easy
dynamic playersUsernames = Exports["core-ztzbx"].getPlayersUsernames();

Get Player Handle from username

string playerUsername = "pepe";
string playerHandle = Exports["core-ztzbx"].getPlayerHandleFromUsername(playerUsername);

Get Player NetworkID from username

string playerUsername = "pepe";
string playerHandle = Exports["core-ztzbx"].getPlayerNetworkIdFromUsername(playerUsername);

Freeze Switch for Player with username

string playerUsername = "pepe";
string playerHandle = Exports["core-ztzbx"].freezePlayerSwitch(playerUsername);