Installation Guide and Usage
Prior warning
You must own Pushover on either iOS or Android in order to use this plugin and register an application key. More information can be found on Pushover's website. Pirating this app will not only cause the app to not function, it will put more strain on a project that needs payment to keep its servers online.
Plugin Installation
In it's first version, the plugin will do no sanity checking on startup to verify that all required files are in place. As a result, these instructions should be followed in full.
Extract the release package to the root of the CraftBukkit installation. You should have a lib folder containing Pushover.jar in the same folder as the server jar. You should have a plugins folder containing the ReportToAdmin folder and the ReportToAdmin.jar file. In the ReportToAdmin folder in the plugins folder, a config.yml file exists.
Open config.yml in your favorite text editor.
Log into Pushover's website and create a new application. Specify 'other' as the category, and make sure it's a privately listed app. Upload an image, and create the app. From this point, go to the application management page, and copy the API token. Put the API token in the YML file, replacing the 'appKey' placeholder under 'pushoverApplicationKey'.
For each admin you wish to get notifications, add a user key under 'pushoverDeviceKeys,' replacing key1 and key2. Do not leave these placeholder keys in tact when you start the plugin - remove unneeded ones.
Change 'YourServerNameHere' to the name of your server.
Grant the users whom you want to be able to send reports the 'shankshock.reporttoadmin' permission node. This permission node must be assigned through Bukkit Permissions, so any management solution that supports it (or DinnerPerms/SuperPerms) should suffice.
Usage
- Any player given the permission can run /reporttoadmin and generate a report. The report system uses the Conversations features of Bukkit, and will ask questions to the player to make the report. At any time, a user can type QUIT to leave and quit the report.
The following is an example report:
The following is an example set of Pushover notifications:
Comments