The Base Config

Default config

The base config file will be stored in config://shine/BaseConfig.json or config://Shine_BaseConfig.json. The default will look something like this:

{
    "ActiveExtensions": {
      "serverswitch": false,
      "basecommands": true,
      "funcommands": false,
      "motd": true,
      "welcomemessages": false,
      "ban": true,
      "votesurrender": true,
      "adverts": false,
      "logging": false,
      "unstuck": true,
      "mapvote": true,
      "afkkick": false,
      "voterandom": false,
      "badges": false,
      "pregame": false,
      "readyroom": false,
      "pingtracker": false,
    },
    "EnableLogging": true,
    "LogDir": "config://shine\\logs\\",
    "DateFormat": "dd-mm-yyyy",
    "TimeOffset": 0,
    "ExtensionDir": "config://shine\\plugins\\",
    "GetUsersFromWeb": false,
    "UsersURL": "http://www.yoursite.com/users.json",
    "RefreshUsers": false,
    "RefreshInterval": 60,
    "SilentChatCommands": true,
    "EqualsCanTarget": false,
    "ChatName": "Admin",
    "AddTag": true,
  }

Config options

Option	Description
ActiveExtensions	This determines which plugins to load on startup. You may load as many or as few as you want.
EnableLogging	This enables Shine’s logging system, which stores log files by date in the LogDir directory.
LogDir	If Shine’s logging system is enabled, then log files will be stored here. Note that subfolders should be denoted with \\ as they are in the default setting.
DateFormat	This determines how Shine should format the date in logs. For Americans, you would use mm-dd-yyyy.
TimeOffset	This determines the time offset from GMT/UTC for log files.
ExtensionDir	This determines where to save the config files for Shine’s plugins.
GetUsersFromWeb	This determines whether the users file should be loaded from a URL instead of locally.
UsersURL	If GetUsersFromWeb is enabled, then this is where Shine will attempt to retrieve the users file from.
RefreshUsers	If set to true, then Shine will automatically refresh users from the web.
RefreshInterval	How long in seconds between user data refreshes. I do not recommend setting this too low.
SilentChatCommands	This determines whether to globally silence chat commands, i.e typing !kick <player> will not show “!kick <player>” in the chat. If this is disabled, then you can still run a command silently by starting it with /.
EqualsCanTarget	Determines whether two players of equal immunity can target each other or not.
ChatName	Determines the name applied to all notifications from Shine that use a name.
AddTag	Determines whether to automatically apply the server tag “shine” to your server. This helps me see which servers are running it. You can disable it by setting it to false if you want to.