Bukkit

Since the plugin's latest update, this page is no longer needed. It will be kept for users using older versions, but anyone using Version 2.0 or newer won't need this.

Where can I find the config.yml?

The plugin's configuration file, the config.yml, can be found inside your server's plugin folder, in a folder named 'ClockSign'. Open the config.yml with either Notepad or Notepad Plus Plus, but I recommend using Notepad Plus Plus, which can be downloaded here.

How do I configure the plugin?

When you open the config file, it should look like this:

# Settings for the ClockSign plugin. For information about the configuration, please visit the plugin's BukkitDev page: http://dev.bukkit.org/bukkit-plugins/clocksign.
settings:
  language: en_US
  updateRate: HIGH
  notifyDenyToConsole: true
  notifyDenyToOperators: true
  notifyRemoveToConsole: true
  notifyRemoveToOperators: true
  operatorJoinMessage: true
  sneakBreakClocks: true
  enableClockEdit: true
clocks:
  defaultTimeFormat: HH:mm
  timezones: PST,GMT,GMT-12,GMT-11,GMT-10,GMT-9,GMT-8,GMT-7,GMT-6,GMT-5,GMT-4,GMT-3,GMT-2,GMT-1,GMT+0,GMT+1,GMT+2,GMT+3,GMT+4,GMT+5,GMT+6,GMT+7,GMT+8,GMT+9,GMT+10,GMT+11,GMT+12
  lockItem: STICK
  alarm:
    alarmSound: ''
updater:
  enable: false
  logConsole: true

 To configure these settings, just simply edit the values after the ':'. I will explain the settings for you:

Settings

• language: The currently selected language file to use. This value should be the name of a language file located in the 'lang' folder. If an incorrect file is specified, the default file 'en_US' will be loaded.
• updateRate: Set to either 'LOW', 'MEDIUM' or 'HIGH'. Defaults to 'HIGH' if nothing is specified. Determines how fast the clocks will be updated. 'LOW' will update the clocks every 10 in-game minutes (which is 8,3 seconds in real-time). 'MEDIUM' will update the clocks every 5 in-game minutes (which is 4,15 seconds in real-time). 'HIGH' will update the clocks every 1 in-game minute (which is 0.83 seconds in real-time).
• notifyDenyToConsole: Set to either 'true' or 'false'. When set to 'true', it will send a message to your server's console when a player tries to create a clock, but doesn't have the required permission for that. When set to 'false', it will not send this message to the console.
• notifyDenyToOperators: Set to either 'true' or 'false'. When set to 'true', it will send a message to every operator currently online on your server when a player tries to create a clock, but doesn't have the required permission for that. When set to 'false', it will not send this message to the operators.
• notifyRemoveToConsole: Set to either 'true' or 'false'. When set to 'true', it will send a message to your server's console when a clock is either removed, or invalid. When set to 'false', it will not send this message to the console.
• notifyRemoveToOperators: Set to either 'true' or 'false'. When set to 'true', it will send a message to every operator currently on your server when a clock is either removed, or invalid. When set to 'false', it will not send this message to the operators.
• sneakBreakClocks: Set to either 'true' or 'false'. When set to 'true', clocks can only be removed by breaking them while crouching/sneaking. When set to 'false', clocks can be normally destroyed like all other blocks.
• enableClockEdit: Set to either 'true' or 'false'. When set to 'true', editing clocks' labels or timezones by (shift+) right clicking is enabled. When set to 'false', this feature is disabled.

Clocks:

• defaultTimeFormat: The default format for displaying the time on the clocks. Use 'HH' for hours, 'mm' for minutes and 'ss' for seconds.
• timezones: This is the list of valid timezones for Real Clocks.Due to Java's limitations, I had to make a list of valid timezones to be able to deny any entry of invalid timezones. Please do not edit this unless you know what you are doing.
• lockItem: The item that is used to right click a clock with to lock it. When a clock is locked, editing by players other than it's owner is denied. Only change this if you know what you are doing, as the standard way of naming items will not work here.
• alarm.alarmSound: The sound that will be heard when an Alarm Clock goes off. Alarm Clocks are not functional yet, so this settings is of no use for now.

Updater:

• enable: Set to either 'true' or 'false. When set to 'true', the plugin will perform a check for updates at startup. If an update is found, it will be downloaded and installed instantly, so it will be ready for the next startup. When set to 'false', this check will not be performed.
• logConsole: Set to either 'true' or 'false'. When set to 'true', the updater will log information about the check to the console. When set to 'false', it will not log information to the console.

There is no config.yml in the folder/There is no ClockSign folder. What do I do now?

Be sure you have run your server at least once with the plugin installed, so it can create all the required files for you. After that, a folder named 'ClockSign' with a file named config.yml in it should be generated. If it doesn't, please report this error to me, by creating a ticket on the Issues page.

After I configured the plugin's settings (config.yml), it gives errors. What do I do now?

Be sure you have set the settings of the config.yml to a valid value. For valid values, check above. If you still experience errors, please report this error to me, by creating a ticket on the Issues page.