Setup

Setup instructions for the plugin.

Docs are WIP (work in progress).

Download and install the latest version of the plugin from SpigotMC or GitHub. If you used the plugin before, make sure to reset (delete) the plugin folder.

Data storage

By default, the plugin will save data into a local player-data.yml file. If you have multiple servers with the plugin and would like to synchronize CPS data across them, you might want to use a MySQL database.

If that's the case, navigate into the configuration file and set storage to DATABASE. You will also need to configure the necessary properties for the connection under database. To be more specific, it is mandatory to configure the host, port, credentials, database and table name.

If you used the plugin before, make sure to set a brand new table name.

Recommendations

The server has no specific way to register when a player clicks, so it must only be assumed from the events. With that being said, if there's an entity at the edge of your reach, and you click on it, that click is counted twice. To avoid CPS farming on this behaviour, the CPS plugin should only be installed on PvP servers (simply none which might open such possibility).

Additionally, you can set entity-clicks-only to true, to avoid this behaviour at the cost of only entity clicks being registered. However, enabling this is also good for PvP servers if you only want to show CPS from combat.

Done! 🎉