1. Installation:

Download the latest version of the plugin available from the official plugin page on SpigotMC. If not installed, download the required dependency ProtocolLib, too. Put the .jar file(s) into the plugins folder of your Spigot server and restart it. This plugin is drag-and-drop, so after finished installation it is ready to use. However, you may want to continue reading.

2. Choosing storage type:

This step refers to configuration at dataStorage in config.yml file.

Test scoreboards need to be saved somewhere. You can choose between 2 options:

FILE - plugin saves scoreboards inside the scoreboard.yml file generated in plugin's folder.
DATABASE - plugin saves scoreboards inside a database.

Comparision:

Here are pros and cons of each storage type:

Storage type	Pros (+)	Cons (-)
`FILE`	Reliable, suitable for networks with only one server with ClicksPerSecond plugin.	May be slow (does not affect perfomance in case of low refresh speed).
`DATABASE`	Fast, reliable, can use SSL, easy and familiar to set up, database is standard for many servers. Supports synchronization across multiple ClicksPerSecond plugins.	-

3. Setting up a database connection:

This step refers to configuration section at dataStorage in config.yml file.

If we chose DATABASE storage type, we need to configure everything needed for a connection.

host: IP of the database host.

port: Port on which is the database hosted (usually 3306).

username: Username to connect with to the database.

password: Password for the username.

database: Name of the database to use.

sslMode: Indicates which connections should the driver (plugin) create to the server (more options are shown here):

DISABLED - establish unencrypted connections,
PREFERRED - establish encrypted connections if the server enabled them, otherwise use unencrypted connections,
DISABLED - establish encrypted connections, if not enabled by the server, do not connect.

timeout: Timeout configuration:

connect: Time in milliseconds for the plugin to establish a connection to the database, until the request times out.
socket: Time in milliseconds for any operation to finish, until it becomes timed out.
reconnect: Delay in seconds between reconnecting attempts, when connection unexpectedly failed (or initially failed to connect) and trying to connect again. Set to 0 for instant reconnecting.

table: Tables to be used by ClicksPerSecond for storing data of each scoreboard. Do not create the specified tables! The plugin will create it by itself with needed columns.

If using a database to store data, synchronization across multiple ClicksPerSecond plugins is supported. Simply, if you have more than one server in your network that uses this plugin, connect them to the same database (and tables) and all plugin instances will synchronize all data.

4. Upgrading from an older version of the plugin?

When ClicksPerSecond plugin enables, it checks for data format version. As of plugin version 2.5, stored data have changed, scoreboard.yml file formatting and database table structure has changed. If ClicksPerSecond plugin detects an outdated format version, it will lock all operations (commands, CPS-tests...) except the reformat and reload command, until you use /cps reformat and the operation finishes. Please see the reformatting page for more information.

If you are using a database to store scoreboards, set table name for right scoreboard to cps_right, left to cps_left and for hack scoreboad to cps_hack. In older versions table names weren't configurable, names were fixed in-code like that. You can get rid of these table names after reformatting, by copying all data to the file and then back to desired database tables.

5. Restart:

Restart the server. Pretty short setup instructions right? Have fun competing in who has higher CPS!