Zen's Utilities Config

What Is This?

My modpack comes with some basic utility functions and features - here is a list of useful config files which get generated in profiles/Zenarchist/Utilities/

ZenUpdateMessage

Config file: profiles/Zenarchist/Utilities/ZenUpdateMessage.json

This file is used for sending announcements to players about recent updates to your server.

For the LOGIN_MESSAGE, you can use these placeholders:

#survivorname#: Will replace with the player's Steam profile name OR their Terje Start Screen name. Works with LOGIN_MESSAGE and UPDATE_MESSAGE #restarttime#: Will replace with server's next restart time (NOTE: This depends on the RestartHours value, and is only really compatible with server update schedules which trigger after server startup (ie. CF Cloud with Use server up-time (relative) enabled). Only works with LOGIN_MESSAGE

{
	"ConfigVersion": "1.29.1", // Don't touch
	"UPDATE_VERSION": "7", // Change this to force a new notification to be sent upon login
	"UPDATE_PREFIX": "Lastest Update:", // Prefix to all update messages
	"UPDATE_SUFFIX": "| Zenarchist.com", // Suffix to all update messages
	"UPDATE_MESSAGE": "We changed.....etc", // Update message text
	"LOGIN_MESSAGE": "Welcome to Zenarchist's Extreme Sakhal, #survivorname#. Type !wiki or !zen in-game for guides. Next restart is in #restarttime#",
	"PopupInGame": 0, // This will make the UPDATE_MESSAGE popup as a dialog box - for important announcements only.
	"NotifySurvivorOfNameChange": 0, // This will trigger the below message if the player's name is "Survivor"
	"SurvivorNotification": "Please change your name to a custom name in the DayZ Launcher (tick Parameters -> Profile name)",
	"RestartHours": 4 // This is only used by #restarttime# placeholder - this is how long til your server restarts after boot-up
}

ZenUtilitiesConfig

Config file: profiles/Zenarchist/Utilities/ZenUtilitiesConfig.json

{
    "ConfigVersion": "1.29.2",
    "ShouldLogPVP": 1, // If enabled, the mod will log PVP activities to the PVP text file
    "ShouldLogDeathGear": 1, // If enabled, the mod will log all of a player's inventory items upon death
    "ShouldLogItemCount": 1, // If enabled, the mod will log the number of items on your server listed in the below cfg
    "ItemTextContains": 1, // If disabled, the items below must match their item classnames EXACTLY or they won't be counted
    "LogItemTypes": [
        "Plastic_Explosive", // List of items to log the count of (saved into the profiles/Zenarchist/Logs folder)
        "ExpansionSatchel"
    ],
    "ShouldLogRaids": 0, // If enabled, the mod will log player raid activity when ammo damage is detected on a Basebuilding object
    "RaidAmmo": [
        "ExpansionC4_Ammo", // A list of 'ammo types' to trigger the base raid logs
        "Plastic_Explosive_Ammo"
    ]
}

PlayerMessageConfig.json

In the folder %server_profile/Zenarchist/Utilities/PlayerReportConfig.json you will find a file where you can send messages to players in-game when they login. You can also spawn items on them with this method. This file is reloaded every time a player logs in to keep it fresh and updated between server restarts.

This is a great way to communicate with players and compensate items for them/spawn event gear on them etc without needing to be online as an admin. All you need is their Bohemia UID or SteamID and a list of items to spawn. A default config is generated in this folder so you can see how to spawn items.

A Bohemia ID looks something like this: 4s_12UDE-PKYemc7adlZyKGVSrwzIMW0T69Q39CerkE=

It's basically a private encrypted version of a player's SteamID and BattlEye ID and whenever a player logs in to the server their UID will be printed to the server logs along with their steam profile name. It's recommended to use this wherever possible to ensure the player's privacy, but if you can't find their UID or the player gives you their SteamID you can use that as the BohemiaID as well and it will work the same way.

If you have server logs enabled, whenever a player dies their entire inventory will also be printed to the server logs in such a way that they can be copy & pasted directly into this config. It helps with compensating players who died to bugs, hackers, server crashes/lag etc much faster than spawning in their gear one by one. It also tracks each item's health and quantity to keep the compensation fair.

You can find the PVP/player death logs in %server_profile/Zenarchist/Logs/TODAYS_DATE/ZenMod_pvp.log. You can use a tool like Agent Ransack to search this file for the player's name or UID if needed as often there will be a lot of info logged there.

The config for spawning items is simple, just add them to the SpawnItems list (check the example config) - there are 3 options:

"Classname" "Classname(quantity)" "Classname(health/quantity)"

If it's an item like a gun you can just use the "Classname" option, if you want to spawn a pristine item with quantity set you can just use "Classname(23)" to spawn 23x the item, to spawn an item with health and quantity set use "Classname(health/quantity)".

Here is an example config:

{
    "PlayerReplies": [
        {
            "BohemiaID": "4s_12UDE-PKYemc7adlZyKGVSrwzIMW0T69Q39CerkE=",
            "Message": "Sorry for that last server crash deleting your stash of 69 nails and fully geared SVD. You'll find them respawned underneath you.",
            "SpawnItems": [
                "Nail(69)",
                "SVD",
                "Mag_SVD_10Rnd(100)",
                "PSO11Optic",
                "Battery9V(100)"
            ]
        }
    ]
}