Sueta

LiveReport [v1.0.0] | Discord/Bungee/MySQL | ReportTracker

1.1.0

All-new feature-packed Simple Report System built for fast and easy management

·Plugin

LiveReport_main_banner.png
Description:
LiveReport is an all-new feature-packed simple report system built for fast and easy management through customizable GUIs.

Version Support: (1.13 >> 1.16.5)
Current Version: 1.0.0 (API: 1.16.5)

Development Roadmap: LiveReport Roadmap | Trello

LiveReport_features_banner.png

  • Plug-N-Play Experience:

- LiveReport comes ready out of the box with over 24 detailed report reasons and easy to use default GUIs.

  • ReportGUI:

- Fully customizable ReportGUI, allowing server admins to add their own report reasons, resize inventories, display names, lores, etc.
- 3 Categories with 24 detailed report reasons out of the box.

Pictures

  • ReportTracker(GUI):

- Easily keep track of active reports thought your server/network
- Never miss a beat with customizable remainders and notifications.
- Report data includes online data (Gamemode, health, operator status, etc.), category of report (Hacking, Chat, Other), date, reason, and ReportProfiles.

Pictures

  • ReportProfile(GUI):

- Every player will have a historical record of every report made against them.
- Including various data points like First Joined, Last Joined, Total Playtime, and more!
- Suspicion Level(LOW, MEDIUM, HIGH): Based on the amount of reports submitted against them.

Pictures

  • BungeeCord Support:

- Automatically notify staff members across the network of new reports
- ** Every server on the network must have LiveReport installed, it only acts as a relay and doesnt handle any report data**

  • MySQL Support:

- Hooking up with MySQL will allow staff members to view report data from every server in your network through the ReportTracker.
- Fast and Reliable, all data operations are done asynchrounsly.
- ** Needed for cross-server ReportTracker **

  • Discord Support:

- Notify staff members of new reports in your Discord server.
- Provides commands to view ReportProfiles and more to come!
- Depends on JDA plugin.

Pictures

  • Automatic Configuration Updates:

- Don't worry about having to tediously port your old config to a new config format. LiveReport automatically handles that!
- **Only applies to config.yml, new values in GUIs.yml will have to be updated manually.**

  • Alerts System:

- Administrators have the ability to disable/enable reports notifications at will.

  • PlaceHolderAPI Support:

- Add your own data points to the ReportDataUI and ReportProfileUI
- ** LiveReport doesn't add any new placeholders it only applies existing ones **

  • Overwatch Notifications:

- Players will be notified whenever there's a change to their report.
- They can also view the status of their report through the /vr command

  • Customizability Options:

- ALL message are fully customizable.
- 24 various report reasons across 3 categories.
- Custom report cooldowns and remainder times.
- Customize every item within the GUIs

Pictures

Report Submitted & Staff Notification

Other Messages


LiveReport_setup_banner.png

BungeeCord Setup:

Setup

1. Download

2. Drop LiveReport.jar into your bungee plugins folder

3. Drop LiveReport.jar in every server in your network.

4. For each server, you can set their "SERVER_NAME"(config.yml) to differentiate them amongst the other servers.

Discord Setup:

Setup

1. Download JDA plugin.
2. Set "DISCORD_ENABLED" to TRUE

Create an Application

1. Go to Discord Developer Portal — My Applications
2. Click "New Application"

3. Give your application a name.

Create a BOT

1. Go to the "Bot" Tab

2. Click "Add Bot"

3. Give your BOT a username(This name will appear on the discord client)

4. Copy your Token

Get your Commands & Reports Channel IDs

1. Enable Developer Mode

2. Right Click and "Copy ID"

Set Values

1. Replace the values in "Discord"(config.yml) with the values we gathered above

Default:
Discord:
token: "token"
reportsChannelID: "channelID"
commandsChannelID: "channelID"
command_prefix: "$"

MySQL Setup:

Setup

1. Gather your database information (Username, database name, ip, port, and password)

2. Set "MySQL_ENABLED"(config.yml) to TRUE

3. Set your databse information in "MySQL" options:

Default:
MySQL:
username: "username"
name: "name"
ip: "ip"
port: "port"
password: "password"

Commands & Permissions:

  • /report (perm: livereport.report) Description: Command used to submit new player reports. Usage: /report <player>
  • /rt (perm: livereport.admin) Description: Open ReportTracker GUI. Usage: /rt
  • /vp (perm: livereport.admin) Description: View someone's ReportProfile(if available) Usage: /vp <player>
  • /alerts (perm: livereport.admin) Description: Turn on/off report notifications. Usage: /alerts
  • /vr (perm: livereport.user_view) Description: View report data using a report ID, allow users to see the status of their report. Usage: /vr <report-id>
  • /lr (perm: livereport.dev) Description: Reload all of LiveReport's configuration files. Usage: /lr

Discord Commands:

  • $vp <player-uuid> : Gather ReportProfile information from player uuid
  • $vr <report-id> : Gather report data from report-id.

Configuration Files:

Config.yml
GUIs.yml

LiveReport_contact_banner.png

You can contact me through Spigot DMs or Discord( terms#9245 ).
Contact me about new features you would like to see added, setup help, questions, bug reports, etc!

Please dont submit bug reports/errors in the review section, it negatively affects my resource an discourages further development.

Similar projects

Plugin →