Zen's Core Mod Guide

ZenModCore Source: https://github.com/ZenarchistCode/ZenModCore

Zen's Core Mod

Many of my mods (including my modpack) require my Zen's Core Mod to run.

This mod contains a lot of framework code which is shared across many of my mods. The point of keeping all this code in a single mod is to reduce bugs and inefficiencies from copy & pasting code across many mods.

My core mod is mostly a framework for code, which the average server admin does not need to worry about. A full explanation of my Core mod's functionality for other modders to interact with can be found in its own code wiki guide.

But this mod does come with some optional admin config setting features which I'll explain below.

When you first run your server with this mod installed it will automatically create a ZenModCoreConfig.json config file in server_profiles/Zenarchist/Core

The core mod also comes with some hard-coded chat commands, the most useful one is !reload (for all configs) and !reload <json filename> (for specific configs) - these commands will force-reload my compatible mod's JSON configs on the server and re-sync them to all clients immediately, which is fantastic for testing & debugging mod configs on the fly (just don't forget to add your personal admin BattlEye ID to the AdminIDs admin list in the Core config).

Below is an explanation of the settings.

Config

Config file: profiles/Zenarchist/Core/ZenModCoreConfig.json

{
    "ConfigVersion": "1.29.2", // Don't touch
    "MapIzurviveURL": "https://www.izurvive.com/sakhal/", // Used for generating map links
    "ZenCore_AdminConfig": {
        "EnableCommands": 1, // Turn on/off !commands in the in-game chat
        "CommandPrefix": "!", // The command prefix symbol
        "AdminIDs": [
            "4s_12UDE-PKYemc7adlZyKGVSrwzIMW0T69Q39CerkE=" // A list of admins with admin privileges
        ],
        "ModeratorIDs": [], // A list of moderators (currently unused - mainly for modders to add lower auth staff commands etc)
        "CommandURLs": { // A command list of eg. !link <Open_URL>
            "wiki": "https://github.com/TerjeBruoygard/TerjeMods/tree/master/WIKI/en",
			"zen": "https://github.com/ZenarchistCode/ZenModPack/wiki",
			"donate": "https://buymeacoffee.com/zenarchist"
        }
    },
    "ZenCore_GeneralConfig": {
        "PreventHologramPlacementAt000": 1, // Prevents deploying objects if hologram is invisible
        "DeleteObjectsAt000": 1 // Deletes any objects which have been deployed while they were invisible
    },
    "ZenCore_LogConfig": { // Controls mod log files
        "EnableLogs": 1, // Enable/disable debug log files
        "FileSuffix": ".log", // The file type to write to
        "KeepLogsDaysCount": 14, // How long to keep old logs before deleting them
        "LogFolderExcludeList": [ // A list of optional folders to NOT print logs to
            "DontPrintToThisFolder"
        ]
    },
    "ZenCore_DiscordConfig": { // Discord webhook API settings
        "EnableDiscord": 1, // Enable/disable Discord functionality in the core mod
        "ServerName": "SAKHAL", // Name of your server instance/map/unique ID
        "PingAdminCommand": "admin", // Allows players to use "!admin <optional message>"
        "AdminWebhooks": [ // List of admin webhooks to send !admin game chat ping commands to
            "Insert admin channel webhooks here"
        ],
        "KillfeedConfig": {
            "EnableKillfeed": 1, // Enable/disable kill feed webhook functionality
            "KillfeedWebhooks": [ // List of killfeed webhooks
                "Insert killfeed channel webhooks here"
            ],
            "DisplayPlayerSteamID": 1, // Display steam ID & profile (admin use)
            "DisplayKillLocation": 1, // Display kill location + map link
            "DisplayKillsByAI": 1 // Display killfeed for Expansion AI vs player
        },
        "PlayerWatchlist": { // A list of players to be notified when they login (sent to AdminWebhooks)
            "4s_12UDE-PKYemc7adlZyKGVSrwzIMW0T32Q69_YOURUID": "Reason they're on this watchlist."
        }
    }
}