Configuration

Overview

DevMate's configuration is managed through the config.json file located in the DevMate folder. This guide provides detailed information about every configuration option available, helping you customize DevMate to fit your server's needs.

Configuration File Location

The configuration file is located at:

DevMate/config.json

Quick Reference

Configuration Options

$schema

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

Type: string

Example:

{
	"$schema": "https://example.com/devmate-config.schema.json"
}

LicenseKey

The LicenseKey field holds the license key obtained from the Big Daddy Scripts Account Page. This key is required for DevMate to function.

Type: string

Example:

{
	"LicenseKey": "your-license-key-here"
}

EventWatcher

The EventWatcher field allows you to specify events to monitor and log. This is useful for debugging and tracking specific game events.

Type: array of objects

Object Structure:

• eventName (string) - The name of the event to monitor
• logLevel (string) - The log level for the event results (one of: INFO, SUCCESS, WARN, ERROR)

Example:

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

timestamp

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

Type: boolean

Example:

{
	"timestamp": true
}

Values:

• true - Include timestamps in all log messages
• false - Omit timestamps from log messages

SendToDiscord

The SendToDiscord field configures settings for sending logs to a Discord Webhook. This is useful for monitoring your server remotely.

Type: object

Object Properties:

• enabled (boolean) - Enable or disable Discord Webhook integration
• WebHookURL (string) - The URL of your Discord Webhook
• level (string) - Log level to send to Discord (one of: INFO, SUCCESS, WARN, ERROR)

Example:

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

SafeRestart

The SafeRestart field defines the behavior for performing safe restarts. Safe Restart ensures all props, vehicles, and maps are properly unloaded before restarting scripts.

Type: object

Object Properties:

• warnTime (number) - Time (in seconds) to wait after sending a warning before beginning the restart process
• lagTime (number) - Time (in seconds) to wait before actually restarting the resource

Example:

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

Recommended Values:

• warnTime: 3-10 seconds (gives players time to react)
• lagTime: 1-3 seconds (allows cleanup to complete)

Permissions

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

Type: object

Object Properties:

• enabled (boolean) - Enable or disable the permissions system
• groups (array) - Define groups and their respective permissions

Group Structure:

• group (string) - The name of the group (must match your server's permission system)
• permissions (array) - A list of permissions for the group

Valid Permissions:

Example:

{
	"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"]
			}
		]
	}
}

Permission Recommendations:

Complete Configuration Example

Here's a complete example configuration file with all options:

{
	"$schema": "https://example.com/devmate-config.schema.json",
	"LicenseKey": "your-license-key-here",
	"EventWatcher": [
		{
			"eventName": "playerSpawned",
			"logLevel": "SUCCESS"
		}
	],
	"timestamp": true,
	"SendToDiscord": {
		"enabled": false,
		"WebHookURL": "",
		"level": "ERROR"
	},
	"SafeRestart": {
		"warnTime": 5,
		"lagTime": 2
	},
	"Permissions": {
		"enabled": true,
		"groups": [
			{
				"group": "admin",
				"permissions": [
					"OpenMenu",
					"EntityViewer",
					"ResourceManager",
					"CodeExecuter",
					"OneSyncBlip",
					"GameModifier",
					"CoordsTool",
					"ResourceExplorer"
				]
			}
		]
	}
}

Configuration Tips

1. Start with Defaults: Begin with the default configuration and adjust as needed
2. Test Permissions: Always test permission configurations in a development environment first
3. Monitor Logs: Use EventWatcher and Discord integration to monitor your server
4. Security First: Be conservative with dangerous permissions like CodeExecuter and ResourceExplorer
5. Backup Config: Always backup your configuration before making major changes