Configuration

This guide provides detailed information about the configuration options available in your application.

Quick Reference Table

info

Use this table for a quick overview of configuration fields. Detailed descriptions are available below.

Field Name	Type	Description
$schema	string	Specifies the configuration schema. Do not modify or remove this field.
LicenseKey	string	Enter your license key from the Big Daddy Scripts Account Page.
EventWatcher	array	Defines events to monitor and log their results.
timestamp	boolean	Enables or disables timestamps in log messages.
SendToDiscord	object	Configures Discord Webhooks for sending logs.
SafeRestart	object	Configures behavior for safe restarts.
Permissions	object	Sets up role-based permissions for different user groups.

$schema

The $schema field specifies the schema for the configuration file, assisting with validation and auto-completion in supported editors.

Parameters

Parameter	Type	Description
$schema	string	Do not modify or remove this field.

warning

Changing or removing this field may cause issues with your configuration.

LicenseKey

The LicenseKey field holds the license key obtained from the Big Daddy Scripts Account Page. Paste your license key into this field to activate the application.

Parameters

Parameter	Type	Description
LicenseKey	string	Your license key from the account page.

EventWatcher

The EventWatcher field allows you to specify events to monitor and log.

Parameters

Parameter	Type	Description
eventName	string	The name of the event to monitor.
logLevel	string	The log level for the event results.

Example

Monitor the playerSpawned event and log the results at the SUCCESS level:

"EventWatcher": [
    {
        "eventName": "playerSpawned",
        "logLevel": "SUCCESS"
    }
]

timestamp

The timestamp field controls whether timestamps are included in log messages.

Parameters

Parameter	Type	Description
enabled	boolean	Set to true to include timestamps in logs.

SendToDiscord

The SendToDiscord field configures settings for sending logs to a Discord Webhook.

Parameters

Parameter	Type	Description
enabled	boolean	Enable or disable Discord Webhook integration.
WebHookURL	string	The URL of your Discord Webhook.
level	string	Log level to send to the Discord Webhook.

Example

Send logs with the ERROR level to a specified Discord Webhook:

"SendToDiscord": {
    "enabled": true,
    "WebHookURL": "https://discord.com/api/webhooks/1234567890/1234567890",
    "level": "ERROR"
}

SafeRestart

The SafeRestart field defines the behavior for performing safe restarts. We recommend using the default values for optimal performance.

Parameters

Parameter	Type	Description
warnTime	number	Time (in seconds) to wait after sending a warning.
lagTime	number	Time (in seconds) to wait before restarting.

Example

"SafeRestart": {
    "warnTime": 5,
    "lagTime": 2
}

Permissions

The Permissions field configures role-based permissions for different user groups, specifying which features each group can access.

Parameters

Parameter	Type	Description
enabled	boolean	Enable or disable the permissions system.
groups	array	Define groups and their respective permissions.

Group Parameters

Parameter	Type	Description
group	string	The name of the group.
permissions	array	A list of permissions for the group.

info

Valid permissions are:

• OpenMenu - Permission to open the DevMate menu.
• EntityViewer - Permission to use the Entity Viewer module.
• ResourceManager - Permission to use the ResourceManager module. (Semi-Dangerous, this allows the group to stop, start, and restart resources)
• CodeExecuter - Permission to use the CodeExecuter module. (Extremely Dangerous, this allows the group to execute code on the server)
• OneSyncBlip - Permission to use the OneSyncBlip module.
• GameModifier - Permission to use the GameModifier module.
• CoordsTool - Permission to use the CoordsTool module.
• ResourceExplorer - Permission to use the ResourceExplorer module. (Extremely Dangerous, this allows the group to see and modify all resources on the server)

Example

Define permissions for admin, developer, and tester groups:

"Permissions": {
    "enabled": true,
    "groups": [
        {
            "group": "admin",
            "permissions": [
                "OpenMenu",
                "EntityViewer",
                "ResourceManager",
                "CodeExecuter",
                "OneSyncBlip",
                "GameModifier",
                "CoordsTool",
                "ResourceExplorer"
            ]
        },
        {
            "group": "developer",
            "permissions": [
                "OpenMenu",
                "EntityViewer",
                "ResourceManager",
                "OneSyncBlip",
                "GameModifier",
                "CoordsTool",
                "ResourceExplorer"
            ]
        },
        {
            "group": "tester",
            "permissions": [
                "OpenMenu",
                "EntityViewer",
                "OneSyncBlip",
                "CoordsTool"
            ]
        }
    ]
}

Notes

• The admin group has full access to all permissions.
• The developer group has similar permissions to admin but lacks CodeExecuter.
• The tester group has limited access suitable for testing purposes.
• Permissions added under permissions will give that group access to that module of DevMate.