Bug Report [1.16.4 - 1.21.4]

Bug Report [1.16.4 - 1.21.4] -----

A simple bug report plugin with GUI to manage player reports

Download Now
372.8 KB .jar

Bug fixes and new features!

Medium sized update to fix and add a couple of features:

Added the ability to export all bug reports to a CSV file.
Added Czech language support.
Removed unneeded debug logs.
Simplified how error messages are handled.
Made "Bug Report Categories" editable.
Added a way to use other language files that aren't hard coded into the plugin.

----------, Nov 13, 2024

Bug fixes and new features!

Medium size change to fix a couple of issues:

Improved performance by removing the temporary English language file and directly checking the key instead of comparing it against the file.
Fixed why the "You have no new reports" message is sent on every player join.
Fixed why the "Enter the max reports a player can submit" message is not getting any user input
Added error codes to all of the error messages in the plugin.
Added multiple pages to the language settings GUI.
Fixed format codes for pluginTitle.

----------, Jul 31, 2024

Bug fixes and new features!

Medium change to fix a couple of issues:

Added notification support between bungee and velocity servers
Add option to enable or disable metrics in config.yml
Fixed Enable Category Bug
Four new keys has been added to allow pings in the Bug Report Message for Discord - discordPingMessage, discordEnablePing, discordPingMembers and discordPingRoles.
Fix BugReportManager cannot be casted to Plugin bug
Fixed "Error getting UUID from API"

----------, Jun 3, 2024

Bug fixes and new features!

Medium change to fix a couple of issues:

- Added new translation keys to the languages/*.yml files.
- Added bug-report-cooldown key to config.yml.
- Fixed status selection back button bug where you couldn't go back to the previous GUI in another language.
- Fixed translations in the " Bug Report Details"
- Fixed category-tab-complete showing when enablePluginReportCategories was set to false
- Added %bugreports_totalDeletedBugReports% to list of placeholders.
- Fixed category tab complete.

----------, Jun 1, 2024

Bug fixes and new features!

Medium change:

- Added the use of external placeholders such as ' %viaversion_player_protocol_version%' within bug reports discord embeds
- Fixed an issue where non-retrievable player heads would repeatedly call the API instead of following cache rules.
- Removed the plugin alias archivedreports.
- Fixed a bug where using the back button after opening a bug report returned to page 1 instead of the previous page. Now, the back button returns to the correct page.
- Translations for the " Bug Report Details" GUI are now customizable.
- Add alternative categories to command auto complete. (/bugreport <category> Testing)
- More permissions for archiving and deleting bug reports

----------, May 31, 2024

New Language System!

Large update that completely changes the language system. Instead of using just one file for all of the languages. They are now separated into their own file in the languages folder such as en_US.yml and de_DE.yml etc. This change is automatic and the old languages.yml file will be ignored!

- Added i18n styled language folder which aims to allow easier editing of languages
- Fixed " You have no new reports" message being sent to all players.
- Added update checker notification to both console and op players.

----------, May 22, 2024

Bug fixes and new features!

Medium update to add some bug fixes and new features.

- Fixed a bug where lowercase status colors were not accepted.
- Fixed a bug where if you change the status of a bug multiple times and then before you archive press back, the GUI will glitch out.
- Fixed the default Bug List Details GUI not loading due to errors.
- Fixed the status item in the default Bug List Details GUI not showing the correct status.
- Added checks to see if playerData.json is valid or not.
- Added more listeners to check if the bugreport book was dropped.
- Added checks after bugreport book is submitted to make sure everything is removed.
- Added the option to change the status in the default Bug List Details GUI.
- Added plugins/BugReport/logs/error. log to hold all of the error messages from the plugin.
- Added truncation to the full message on the default Bug List Details GUI.

----------, Apr 28, 2024

Bug fixes and new features!

Small update to add some bug fixes and new features.

- Added %report_server_name% to the discordEmbedFields list in config.yml.
- Added serverName config option to config.yml.
- Added serverName to both bug report and BugList Details GUI.
- Added BugReportServerName key to custom_bug_report_details_GUI.yml file.
- Changed both confirmation pages to return back to original BugList Details GUI after deletion or archive.
-Updated /buglist help admin command to include other subcommands.
- Added more checks to see if the Status Color is valid or not.

----------, Apr 14, 2024

Bug fixes and new features!

Relatively large update to bring new bug fixes and features to Bug Report!

- Fixed minor spelling mistake for Teleportation error.
- Fixed " SQL error or missing database (duplicate column name: status)" error message.
- Fixed back button in the Confirmation GUI to return to the Bug Report Details page instead of going back to all Bug Reports page.
- Changed close button to back button in Status Selection GUI.
- Fixed back button in the Status Selection GUI to return to the Bug Report Details page instead of going closing.
- Updated /buglist version to show the correct URL.
- Added more customizable keys for the Discord Embed in config.yml.

New Config Keys:

Code (YAML):

discordEmbedFields:
- name : "Username"
id : 1
value : "%report_username%"
inline : true
- name : "UUID"
id : 2
value : "%report_uuid%"
inline : true
- name : "World"
id : 3
value : "%report_world%"
inline : true
- name : "Location (X, Y, Z)"
id : 4
value : "%report_location%"
inline : true
- name : "Gamemode"
id : 5
value : "%report_gamemode%"
inline : true
- name : "Status"
id : 6
value : "%report_status%"
inline : true
- name : "Category"
id : 7
value : "%report_category%"
inline : true
- name : "Full Message"
id : 8
value : "%report_full_message%"
inline : false

----------, Apr 9, 2024

Major bug fixes!

This update brings two major bug fixes regarding the languages option. Please use this version instead of v0.11.0.

- Fixed an issue where you couldn't select a new status option in any language.
- Fixed an issue where you couldn't delete or archive a bug report in another language other than English.

----------, Apr 6, 2024

Bug fixes and new features!

Large update to add bug fixes and more improvements!

- Removed all instances of System.out.println()
- Cleaned up the code to avoid duplicated lines.
- Allowed pluginTitle to override other colors.
- Linked " Enable Player Heads" with the Discord Webhook.
- If Error getting UUID from API, then make sure to always send the Discord Webhook message.
- Made enableBugReportNotifications turn off " noNewReportsMessage"
- Fixed a bug where normal players without OP still get shown the " X number of bug reports submitted" message.
- Added a /bl version command.
- Added newReportsMessage and noNewReportsMessage to the languages.yml file.
- Added sounds to button clicks in all GUI's.
- Added a new GUI to the delete/archive to make sure the user really wants to delete/archive a report.
- Removed " Add Status" as it was causing too many issues.
- Fixed messages not having the pluginColor and pluginTitle.

New Language Keys:

Code (YAML):

confirmationDelete : "Delete Bug Report?"
confirmationArchive : "Archive Bug Report?"

Removed Language Keys:

Code (YAML):

addStatus : "Add Status"

----------, Apr 6, 2024

Bug fixes and new features!

Small update to fix bugs and add new features!

- Added both "reload", "help" and "debug" subcommands to the "buglist" command.
- Removed the "report" and "reports" aliases from the plugin.
- Fixed an issue where if you teleport to a null location, the GUI freezes.
- Added the ability to submit bug reports from a book.
- Fixed an issue with the "On", "Off" options in the Settings GUI.
- Added an option to enable book reports in the Settings GUI.
- Added Debug Mode. ( Should only be used if the plugin is not working correctly, this will create a lot of log messages!)

New Language Keys:

Code (YAML):

enableReportBook : "Enable Report Book"

New Config Keys:

Code (YAML):

enablePluginReportBook : false

----------, Mar 6, 2024

Bug fixes and custom statuses!

Relatively large update to include the ability to add custom statuses to your reports! This is still in beta and maybe changed in the future, any bugs please let me know!

- Fixed the option to disable player heads.
- Fixed the IndexOutOfBounds issue with the GUI.
- Fixed the "On" and "Off" buttons showing as "null".
- Added the option to edit/add/delete custom statuses.
- Added the ability to change the status of a report.

----------, Feb 26, 2024

Bug fixes!

Small update to fix a few bugs.

- Fixed Plan dependency issues.
- Fixed ReportCreatedEvent from not triggering synchronously.
- Added more cases to teleporting.

----------, Feb 5, 2024

New Custom GUI support!

A relatively large update with support for a custom GUI on both the " Bug Report Details" and " Archived Bug Report Details" GUI.

Added support for custom GUI's.
Fixed bug with languages not loading correctly with the custom GUI.
Updated Plan with new tables and general bug fixes.

If you have any issues, feel free to join the Discord Server or post an issue on GitHub.

New YML file ( custom_bug_report_details_GUI.yml):

Code (YAML):

# Slots always start from 0 and go up to the max guiSize value.

# The list of valid bugReportItem instances are
# BugReporter, BugReportUUID, BugReportWorld, BugReportMessage, BugReportCategory, BugReportStatus, BugReportTimestamp
# BugReportLocation, BugReportGamemode, BugReportArchive, BugReportBack, BugReportDelete

# Any of these items can have a texture, the list of textures can be obtained from here: https://minecraft-heads.com/custom-heads
# Then select the "Value" under the "For Developers:" section and paste it in the texture field.

# The only material that accepts an array of materials is BugReportStatus. Any other bugReportItem won't accept this type!

# The list of all items that can have a texture are:
# BugReportUUID, BugReportWorld, BugReportMessage
# BugReportCategory, BugReportTimestamp, BugReportLocation
# BugReportGamemode, BugReportArchive, BugReportDelete

bug_report_details_GUI:
guiSize : 45 # The GUI size can be between 9 and 54 but has to be a multiple of 9.
items:
- slot : 1
bugReportItem : BugReporter
material : PLAYER_HEAD # For player texture, use %player_texture%. Only works for BugReporter.
texture : "%player_texture%"
- slot : 3
bugReportItem : BugReportUUID
material : NAME_TAG
texture : ""
- slot : 5
bugReportItem : BugReportWorld
material : GRASS_BLOCK
texture : ""
- slot : 7
bugReportItem : BugReportMessage
material : PAPER
texture : ""
- slot : 18
bugReportItem : BugReportCategory
material : CHEST
texture : ""
- slot : 20
bugReportItem : BugReportStatus
material : [LIME_DYE, RED_DYE ] # First item is Active, Second is Archived
- slot : 22
bugReportItem : BugReportTimestamp
material : CLOCK
texture : ""
- slot : 24
bugReportItem : BugReportLocation
material : COMPASS
texture : ""
- slot : 26
bugReportItem : BugReportGamemode
material : DIAMOND_SWORD
texture : ""
- slot : 38 # For BugReportArchive and BugReportUnArchive, only one will ever show depending on the GUI. The other will be hidden.
bugReportItem : BugReportUnArchive
material : PLAYER_HEAD
texture : "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDVjNTg4YjllYzBhMDhhMzdlMDFhODA5ZWQwOTAzY2MzNGMzZTNmMTc2ZGM5MjIzMDQxN2RhOTNiOTQ4ZjE0OCJ9fX0="
- slot : 38
bugReportItem : BugReportArchive
material : PLAYER_HEAD
texture : "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvY2Y5YjY3YmI5Y2MxYzg4NDg2NzYwYjE3MjY1MDU0MzEyZDY1OWRmMmNjNjc1NTc1MDA0NWJkNzFjZmZiNGU2MCJ9fX0="
- slot : 40
bugReportItem : BugReportBack
material : BARRIER
- slot : 42
bugReportItem : BugReportDelete
material : PLAYER_HEAD
texture : "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYmUwZmQxMDE5OWU4ZTRmY2RhYmNhZTRmODVjODU5MTgxMjdhN2M1NTUzYWQyMzVmMDFjNTZkMThiYjk0NzBkMyJ9fX0="

----------, Feb 4, 2024

Bug fixes and new features!

Small update to fix bugs and add in both Placeholder API and Plan support.

Fixed adding in new database tables.
Fixed update checker throwing error message on player join.
Added in Placeholder API.
Added in Plan compatibility.

Placeholder API Keys

%bugreports_totalBugReports% - (Returns the total amount of bug reports)
%bugreports_totalArchivedBugReports% - (Returns the total amount of archived bug reports)
%bugreports_totalNonArchivedBugReports% - (Returns the total amount of non-archived bug reports)

----------, Jan 21, 2024

Bug fixes and new features!

Things changed:

Removed testing print lines.
Fixed 1.20.2 bug with player heads in the Bug List GUI.
Added a new command so players can reach the settings page quicker - /bls or /buglistsettings.
Changed status icon in the Bug List GUI to "LIME_DYE" if not archived and "RED_DYE" if archived.
Added status icons to the Language Settings GUI which will show "LIME_DYE" if enabled and "RED_DYE" if the language has not chosen.
Added player heads to Bug List GUI as well as all of the individual Bug Report GUI's.
Added which gamemode the player was into the Bug Report.
Added an update checker on player join.

----------, Jan 2, 2024

Bug Fixes and new features!

Small update to introduce "Location" and two new languages.

The players location has now been added to both the buglist GUI and the Discord Webhook message.
Two new languages have been added "Simplified Chinese" and "Russian"
Added the option to teleport to the players location of the bug report.

----------, Dec 5, 2023

Bug Fixes and new features!

Small update to fix some issues and minor improvements.

Fixed an issue if there are no bug reports in the GUI, the total pages would be zero.
Fixed the Bug List GUI forward and back buttons to only show if there are more than one pages.
When a new bug report is submitted and the Bug List GUI is open, the GUI will now update automatically.
Added an option to unarchive bug reports.

----------, Dec 3, 2023

Bug Fixes and new features!

Small update to fix some small bugs and to add new bug details to the " Bug Report Details" GUI.

- Added a Status and Timestamp info in the " Bug Report Details" GUI (Status will be added in a later release)
- Fixed a bug where you couldn't archive or delete bug reports in a language other than English.
- Fixed a bug where after a player submits a bug report, it does not show in the GUI.
- Fixed the Archive and Delete icons where they were flipped.

----------, Nov 1, 2023

Bug Fixes and new features!

This is a big update to fix and add new features:

Fixed bug with the Discord Timestamp showing the incorrect time.
Fixed event handler for the Bug Report Settings GUI returning the incorrect type.
Fixed an issue with the database connection where it wouldn't close the connection when the plugin was disabled.
Fixed an issue where you couldn't see other players bug reports apart from your own.

Readded the ability to view player heads in a bug report (This was broken in previous versions)

Added the ability to send a title message instead of a player message.
Added the option to enable or disable player heads in a bug report.
Added a new GUI "Other Settings" to show more customizable options.
Added caching so the plugin doesn't try and get player heads every time the GUI is open.
Added a notification message when a player joins, they get notified on how many reports were submitted.

Any issues, feel free to join the Discord Server or posting an issue on the GitHub.

Added keys in languages.yml

Code (YAML):

otherSettings : "Other Settings"
enableTitleMessage : "Enable Title Message"
enablePlayerHeads : "Enable Player Heads"

Added keys in config.yml

Code (YAML):

useTitleInsteadOfMessage : false
enablePlayerHeads : true
refreshPlayerHeadCache : 1d # Default, 1m, 1h, 1d, 1w, 1mo, 1y

----------, Oct 31, 2023

Customizable Discord Embeds

Small update that has been requested is the ability to customize the bug report Discord messages. The customizable options are as follows:

EmbedColor (This is the color to the left of the embed - Default is Green)
EmbedTitle (This is the title of the embed - Default is "New Bug Report")
EmbedFooter (This is the footer of the embed - Default is "Bug Report v0.6.3")
EmbedThumbnail (This is the image to the top right of the embed - Default is the Bug Report Logo)
EnableThumbnail
EnableUserAuthor (This adds the players name and avatar image to the top of the embed - Default is true)
IncludeDate (A timestamp is added at the bottom of the embed - Default is true)

----------, Oct 21, 2023

[BETA] Deleting and Archiving Bug Reports

If you are planning on using this plugin for your server in a production environment, please do so at your own risk!

This release follows from the previous release and adds the ability to delete and archive bug reports.
A new command has been added /archivedreports or /bla. This command will show a new GUI with all of the archived bug reports.

As this plugin is still very much in beta, please only use this update if you don't already have bug reports and if you find any issues, please let me know on GitHub or through Discord.

Note: As more and more features are added, the plugin is becoming unstable which means I will need to recode most of the plugin. The plugin is nearing the first production release where the plugin will become more robust!

----------, Oct 9, 2023

[BETA] Archiving Bug Reports

Use with caution:
This release adds the ability to archive bug reports. This update may break previous databases so any issues you have may require using a new database table. As this plugin is still very much in beta, please only use this update if you don't already have bug reports and if you find any issues, please let me know on GitHub or through Discord.

Note: You won't be able to delete bug reports at the moment.

Two new keys have been added to languages.yml which are

Code (YAML):

archive : "Archive"
delete : "Delete"

----------, Oct 4, 2023

Remote Database Support!

A highly requested feature has now been added, this means you can now use remote MySQL databases! To use this feature, you will need to add the following to the config.yml file.

Code (YAML):

databaseType : mysql
database:
host : localhost
port : 3306
database : database
username : root
password : password

You can also change the title and color of messages from "[Bug Report]" to anything you would like by changing the following config.

Code (YAML):

pluginColor : Yellow
pluginTitle : "[Bug Report]"

The languages.yml file has also been changed which adds more configuration such as button names! If you need to fetch the latest update of the file click here.

Any issues, you are welcome to join the Discord Server or by posting an issue in our GitHub!

----------, Oct 1, 2023

New Language Feature

With this update you will be able to set the language of Bug Report between 5 predefined languages - "Italian", "Deutsch", "French", "Espanol" and "English". The translations may not be 100% correct so if you know the language, you are more than welcome to submit a pull request. You are able to change the different messages through the languages.yml file.

I have tried to fully test the functionality of this update but there may still be bugs. If you find any, you are more than welcome to submit an issue.

----------, Jul 6, 2023

New Settings GUI

A major update that I have been working on is the ability to customize the Bug Report plugin through a Settings Page. Currently there aren't many options to choose from but as the functionality has already been built there are many new features to be added in the future! If not added manually, the new configuration options will be automatically included.

Code (YAML):

enableDiscordWebhook : true
enablePluginReportCategories : false
enableBugReportNotifications : false

max-reports-per-player : 10
report-confirmation-message : Thanks for submitting a report!

----------, Jul 5, 2023

Fixed bugs with creating plugin folder

Fixed bugs when the plugin first starts and creates the plugin folder. Any issues that say that the folder does not exist have now been resolved.

----------, Jul 2, 2023

Fixed bugs with categories

With v0.3.4, I have added some error checking for the report categories which checks if all values and keys are present in the config.yml file if enablePluginReportCategories is true.

----------, Jul 2, 2023

Added the option to add Bug Categories

With this update, you are now able to add categories to the /bugreport command. When enablePluginReportCategories is enabled, instead of doing /bugreport <message>, you will only need to use /bugreport where the user is then shown a GUI with the different categories.

Code (YAML):

webhookURL : https://discord.com/api/webhooks/

enablePluginReportCategories : true
reportCategories:
- name : Plugin Bug
id : 1
description : Report a bug with a plugin
item : minecraft:book
color : red
- name : Server Bug
id : 2
description : Report a bug with the server
item : minecraft:emerald
color : green
- name : Resource Bug
id : 3
description : Report a bug with the resource pack
item : minecraft:map
color : blue
- name : Other
id : 4
description : Report something else
item : minecraft:paper
color : yellow

This plugin is in pre-development so bugs are likely, if you are looking for a stable version of this plugin, please wait for the 1.X.X releases.

----------, Jul 2, 2023

Added the option to add Bug Categories

This plugin is in pre-development so bugs are likely, if you are looking for a stable version of this plugin, please wait for the 1.X.X releases.

----------, Jul 1, 2023

Bug Report Read Status Update

Small update, please remember to back up the database file in /plugins/BugReport/database.db before updating. From testing I have not had any data loss.
As it's not stable yet, the structure of the database may/will change over the 0.X.X updates.

Fixed an issue where an error message was being shown when the Discord Webhook was incorrect.
Added support for tracking the read status of bug reports.

----------, Jul 1, 2023

BugList Command GUI Navigation Improvement

This update improves navigation in the /buglist command's GUI by adding a back and forward button with multiple pages. The bugreports.db file has now been moved to plugins/BugReport so it is not to be confused with any other files you may have.

----------, Jun 28, 2023

Fixed minor bugs with Discord Webhooks

Small update to fix the following issues.

TTS was enabled by default, this has now been disabled.
Any player could set the Webhook URL, this has now been changed to only players with the bugreport.admin permission.

----------, Jun 25, 2023

Discord Webhook Support

Quick added feature is the ability to add a webhook to receive notifications on new Bug Reports! To use the new feature, simply use the command /buglinkdiscord <Webhook URL> to start getting notifications in any Discord Channel every time someone types the /bugreport command.

----------, Jun 25, 2023

View on SpigotMC

Resource Information

Author:

----------

Total Downloads: 2,621

First Release: Jun 24, 2023

Last Update: Nov 13, 2024

Category: ---------------

All-Time Rating:

10 ratings

Version -----

Released: --------------------

Downloads: ------

Version Rating:

----------------------

-- ratings

Ask Questions / Get Support