GameLabs

Introduction

The GameLabs plugin for DayZ allows your game server to interact with the CFTools Cloud GameAPI.

It will automatically transmit relevant events as well as player and environment information. Additionally, it acts as a library for other mods to interact with CFTools Cloud components or core GameLabs data.

To install GameLabs follow the "Installation" section.

Requirements

• CFTools Cloud server registration or Open GameLabs compatible API Server
• Server Id and API Key (Server, Manage, Settings, API Key)

Installation

Install/load this mod to you the target game server deployment.

For the configuration, create a file called gamelabs.cfg in your profiles directory (Do not add any additional file extensions). Inside this file, put following JSON configuration:

{
 "debugEnabled": 1,
 "connectionVerification": 0,
 "serverId": "Server-Id",
 "apiKey": "API-Key",
 "preventDynamicItemPopulation": 0,
 "chatSanitizeBattlEyeJoinLeave": 0,
 "chatSanitizeBattlEyePrefix": 0,
 "advancedChatInterface": 0,
 "lockServerOnStart": 0,
 "enableMetricsDump": 0,
 "reportingWebhookUrl": "",
 "reportingWebhookUrlType": "discord",
 "reportingEnabled": 0,
 "reportingElements": [
  "deathScreen",
  "escapeMenu"
 ]
}

Replace the Server-Id and API-Key placeholders with your appropiate API information. The file must be saved in either ANSI or UTF-8 format, depending on your OS language settings.

Full documentation available on GitHub

Extended configuration

connectionVerification

GameLabs will automatically verify its access credentials and shut down the server if the API is unreachable or the credentials are invalid. To disable GameLabs shutting down your server for when the API is unreachable set [code]connectionVerification[/code] to 0. When connection verification is disabled, we can and will not guarantee that GameLabs is functioning correctly.

debugEnabled

Enable or disable GameLabs's debug mode. If you encounter issues, it is recommend to enable debug mode and check the log output generated in profiles/@Logging.

preventDynamicItemPopulation

GameLabs automatically scans your game server for all available items. If your server has more than 50.000 unique items, this may lead to issues. We heavily discourge disabling this setting. Consult CFTools Cloud support if you think your setup requires this.

serverId / apiKey

These fields must contain your API credentials. You can find them under "Manage", "Settings", "API Key". Only the owner of any specific server may access them. These credentials are required in order for GameLabs to function and the server must be registered with CFTools Cloud before GameLabs can be used.

chatSanitizeBattlEyeJoinLeave

Sanitize chat from BattlEye join/leave messages.

chatSanitizeBattlEyePrefix

Remove BattlEye message prefix.

advancedChatInterface

Support for stylizing RCon messages or displaying them as notification. This may break other chat mods, so testing is recommended.

lockServerOnStart

This flag will cause the game server to become locked during startup. When enabled, a manual (or automated for example CFCloud Scheduler) unlock is required.

Extended functionality

DayZ Expansion

GameLabs is able to transmit Side and Team chat for DayZ Expansion. GameLabs MUST be launched on the client side for Expansion chat support

In-Game Reporting

The in-game reporting module allows players to report other players. The report will be delivered via WebHook to an URL of your choosing. Reporting supports Discord WebHooks or non Discord formats for expanded details.

Enabling the module requires `reportingEnabled` to be set to `1`.

The display options can be overriden by modding the elements GameLabs has implemented. For base configuration, `reportingElements` allows you to customize in which situations reporting will be displayed. - `deathScreen` will render a report button when a player is killed (PVP kills only) - `escapeMenu` will render a report button when the player opens their menu via ESC

GameLabs MUST be launched on the client side for reporting

Message styling

Requires "advancedChatInterface" to be enabled and GameLabs to be installed on both client and server.

To send stylized RCon messages you prefix the specific messages the following way: - [code]|>N[/code] (Sending a notification) - [code]|>C(HEX)[/code] (Sending a colorized message) - [code]|>X(duration)|(icon)|(title)|(text)[/code] (Sending a customizable notification, empty fields use defaults)

Full examples for RCon messages: "|>NThis is a notification" "|>C37ff00This message will appear green” "|>X10||Announcement|Server restart in 5 minutes"

Messages stylized this way, will not have any prefix.

Chat styling is not compatible with every chat mod.

Logging

GameLabs has an integrated and custom logger. The log files will be generated inside a @Logging directory, which is being located in the configured profiles directory.

Managing User Consent

Depending on your region, you might require a “cookie consent” banner when using client performance metrics (gathering of client game FPS for server metrics, etc.). You can enable this by adding:

#define GAMELABSCLIENTCONSENT

in any mod that is loaded before GameLabs on the client.

Game server monetization

The usage of GameLabs on monetized servers is allowed. The usage of GameLabs for commercial use is forbidden in compliance with the DayZ Tools EULA.

Usage

The usage of GameLabs is subject to the CFTools Cloud Terms of Use.

Compatibility