Logging

Overview

The logging plugin hooks into many events and logs them into Shine's daily log file.

Configuration

The default config file should look something like this:

{
    "LogChat": true,
    "LogCommanderLogin": true,
    "LogConnections": true,
    "LogConstruction": true,
    "LogConsuming": true,
    "LogEjectVotes": true,
    "LogGameVotes": true,
    "LogKills": true,
    "LogNameChanges": true,
    "LogRecycling": true,
    "LogRoundStartEnd": true,
    "LogTeamJoins": true,
    "__Version": "1.2"
}

The file should be called "Logging.json" and should be placed in the directory defined as your plugin config directory (default is config://shine/plugins).

Option	Description
LogChat	Sets if chat messages are logged.
LogCommanderLogin	Sets if commanders logging in and out of command structures is logged.
LogConnections	Sets if players connecting and disconnecting is logged.
LogConstruction	Sets if structures being built is logged.
LogConsuming	Sets if consuming of Alien structures is logged.
LogEjectVotes	Sets if eject votes are logged.
LogGameVotes	Sets if votes initiated through the game's vote menu (e.g. kick player, randomise ready room) are logged.
LogKills	Sets if kills are logged.
LogNameChanges	Sets if name changes are logged.
LogRecycling	Sets if recycling of buildings is logged.
LogRoundStartEnd	Sets if round starts and ends are logged.
LogTeamJoins	Sets if players joining teams is logged.

Log files

The log files are stored in config://shine/logs by default and will be made one per day. The name will correspond to the date they represent and will respect your date format given in the Shine base config.

Logs also have a timestamp and provide detailed information about each player.