# Bug Report
\n## What is Bug Report?
\nBug Report is a tool that helps server owners manage any bugs found by players which can then be accessed by a GUI. This is especially helpful as information about the player is stored as soon as they submit a bug report. Information collected when a bug report is submitted is as follows:
\n1. Server Name
\n2. Player Name
\n3. Player’s UUID
\n4. Current World Name
\n5. Full Message
\n6. Category ID (If the option is turned on)
\n7. Status (Can be customized using a GUI)
\n8. Date & Time
\n9. Player’s Location
\n10. Player’s Game Mode
\nYou can archive\/unarchive\/delete bug reports, customize the “Bug Report Details” GUI, customize all of the statuses, language selector and more!<\/p>\n
## Commands ## Command Aliases<\/p>\n – **\/br ## Permissions ## Plan Support ## Custom GUI Support %bugreports_totalBugReports% – (**Returns the total amount of bug reports**) ## Discord Support Example Main Config File<\/p>\n “`yaml enableDiscordWebhook: false # Either one of them has to be true, they both can not be true at the same time language: en_US<\/p>\n update-checker: true # # Available placeholders: # If you want to ping a role or a member, you can add them here. You can add multiple roles and members. A simple bug report plugin with GUI to manage player reports.<\/p>\n","protected":false},"featured_media":35469,"template":"","meta":{"_minecraft_slug":"bugreport","_minecraft_project_id":"QJ9FgEF0","_minecraft_author":"ItsLeon15","_minecraft_license":"LicenseRef-EPL-2.0","_minecraft_downloads":314,"_minecraft_follows":7,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"bugreport.zip","_minecraft_size_bytes":723774,"_minecraft_version_count":2,"_minecraft_updated_at":"2026-05-16T11:40:07.061004Z","_minecraft_date_created":"2025-03-17T03:37:44.257927Z","_minecraft_date_modified":"2025-03-17T04:00:21.015857Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/bugreport","_minecraft_icon_attachment_id":35469,"_minecraft_imported_at":"2026-06-01T17:13:29+00:00","_minecraft_import_hash":"b2e7d99e7541280b2bc3ff2b8a6d2e0a","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,126,127,129,92],"mod_loader":[130,132,134],"minecraft_version":[118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82,83,167,163],"class_list":["post-35468","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-management","mod_category-paper","mod_category-spigot","mod_category-utility","mod_loader-bukkit","mod_loader-paper","mod_loader-spigot","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9","minecraft_version-26-1","minecraft_version-26-1-1","minecraft_version-26-1-2"],"yoast_head":"\n
\n– **bugreport
\n– **buglist** – This shows a GUI with all the reports made on the settings page.
\n– **buglistsettings** – This shows the Bug List Settings GUI.
\n– **buglistarchived** – See all of the bug reports that have been archived in a GUI.
\n– **buglinkdiscord
\n– **\/bl** (\/buglist)
\n– **\/bla** (\/buglistarchived)
\n– **\/bls** (\/buglistsettings)
\n– **\/bld
\n– bugreport.admin – Allows the player to manage bug reports
\n– bugreport.notify – Receive notifications for bug reports
\n– bugreport.archived – Allows the player to access the archived bug reports
\n– bugreport.settings – Allows the player to access and change the settings of the plugin
\n– bugreport.list – Allows the player to access the list of bug reports
\n– bugreport.use – Allows the player to use the bug report command
\n– bugreport.archive – Allows the player to archive bug reports
\n– bugreport.delete – Allows the player to delete bug reports<\/p>\n
\nBug Report now supports the Plan API. To use Bug Report with Plan, you will need to install Plan onto your Spigot Server and it should set up everything automatically.<\/p>\n
\nBug Report now supports the ability to customize GUIs, to customize a GUI simply navigate to the `custom_bug_report_details_GUI.yml` file and then choose whatever style GUI you would like. This is currently in BETA so bugs are likely to be found. YML file is below:
\n“`yaml
\n# Slots always start from 0 and go up to the max guiSize value.
\n# The list of valid bugReportItem instances are
\n# BugReporter, BugReportUUID, BugReportWorld, BugReportMessage, BugReportCategory, BugReportStatus, BugReportTimestamp
\n# BugReportLocation, BugReportGamemode, BugReportArchive, BugReportBack, BugReportDelete, BugReportServerName
\n# Any of these items can have a texture, the list of textures can be obtained from here: https:\/\/minecraft-heads.com\/custom-heads
\n# Then select the “Value” under the “For Developers:” section and paste it in the texture field.
\n# The only material that accepts an array of materials is BugReportStatus. Any other bugReportItem won’t accept this type!
\n# The list of all items that can have a texture are:
\n# BugReportUUID, BugReportWorld, BugReportMessage
\n# BugReportCategory, BugReportTimestamp, BugReportLocation
\n# BugReportGamemode, BugReportArchive, BugReportDelete, BugReportServerName
\n# BugReportStatus will be terminated if a custom status is provided.
\nbug_report_details_GUI:
\n guiSize: 45 # The GUI size can be between 9 and 54 but has to be a multiple of 9.
\n items:
\n – slot: 0
\n bugReportItem: BugReportServerName
\n material: DIAMOND
\n texture: “”
\n – slot: 2
\n bugReportItem: BugReporter
\n material: PLAYER_HEAD # For player texture, use %player_texture%. Only works for BugReporter.
\n texture: “%player_texture%”
\n – slot: 4
\n bugReportItem: BugReportUUID
\n material: NAME_TAG
\n texture: “”
\n – slot: 6
\n bugReportItem: BugReportWorld
\n material: GRASS_BLOCK
\n texture: “”
\n – slot: 8
\n bugReportItem: BugReportMessage
\n material: PAPER
\n texture: “”
\n – slot: 18
\n bugReportItem: BugReportCategory
\n material: CHEST
\n texture: “”
\n – slot: 20
\n bugReportItem: BugReportStatus
\n material: [ LIME_DYE, RED_DYE ] # First item is Active, Second is Archived
\n – slot: 22
\n bugReportItem: BugReportTimestamp
\n material: CLOCK
\n texture: “”
\n – slot: 24
\n bugReportItem: BugReportLocation
\n material: COMPASS
\n texture: “”
\n – slot: 26
\n bugReportItem: BugReportGamemode
\n material: DIAMOND_SWORD
\n texture: “”
\n – slot: 38 # For BugReportArchive and BugReportUnArchive, only one will ever show depending on the GUI. The other will be hidden.
\n bugReportItem: BugReportUnArchive
\n material: PLAYER_HEAD
\n texture: “eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDVjNTg4YjllYzBhMDhhMzdlMDFhODA5ZWQwOTAzY2MzNGMzZTNmMTc2ZGM5MjIzMDQxN2RhOTNiOTQ4ZjE0OCJ9fX0=”
\n – slot: 38
\n bugReportItem: BugReportArchive
\n material: PLAYER_HEAD
\n texture: “eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvY2Y5YjY3YmI5Y2MxYzg4NDg2NzYwYjE3MjY1MDU0MzEyZDY1OWRmMmNjNjc1NTc1MDA0NWJkNzFjZmZiNGU2MCJ9fX0=”
\n – slot: 40
\n bugReportItem: BugReportBack
\n material: BARRIER
\n – slot: 42
\n bugReportItem: BugReportDelete
\n material: PLAYER_HEAD
\n texture: “eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYmUwZmQxMDE5OWU4ZTRmY2RhYmNhZTRmODVjODU5MTgxMjdhN2M1NTUzYWQyMzVmMDFjNTZkMThiYjk0NzBkMyJ9fX0
\n“`
\n## Placeholder API Support
\nBug Report now supports Placeholder API, the keys for Bug Report are the following with more to come in the future.<\/p>\n
\n%bugreports_totalArchivedBugReports% – (**Returns the total amount of archived bug reports**)
\n%bugreports_totalNonArchivedBugReports% – (**Returns the total amount of non-archived bug reports**)<\/p>\n
\nIf you need any support or have features you want to be added to Bug Report, you can join the Discord here – https:\/\/discord.gg\/jXsV3xQJD4.<\/p>\n
\nwebhookURL: https:\/\/discord.com\/api\/webhooks\/<\/p>\n
\nenablePluginReportBook: false
\nenableBugReportNotifications: true<\/p>\n
\nenablePluginReportCategoriesGUI: false # Set to true if you want a category selection GUI after doing \/bugreport
\nenablePluginReportCategoriesTabComplete: false # Set to true if you want a category tab completion after doing \/bugreport. No GUI will open<\/p>\n
\nupdate-checker-join: true<\/p>\n
\n#
\n# Aqua, Black, Blue, Dark_Aqua, Dark_Blue
\n# Dark_Gray, Dark_Green, Dark_Purple, Dark_Red
\n# Gold, Gray, Green, Light_Purple, Red, White, Yellow
\ndiscordEmbedColor: Green
\ndiscordEmbedTitle: New Bug Report
\ndiscordEmbedFooter: Bug Report v0.12.3
\ndiscordEmbedThumbnail: https:\/\/www.spigotmc.org\/data\/resource_icons\/110\/110732.jpg
\ndiscordEnableThumbnail: true
\ndiscordEnableUserAuthor: true
\ndiscordIncludeDate: true<\/p>\n
\n# The role or member will be pinged in the message you set in discordPingMessage.
\n# You don’t need to add the “<@\" or \"<@&\" characters to the role or member. They will be added automatically.\ndiscordPingMessage: A new Bug Report has been submitted\ndiscordEnablePing: true\n\ndiscordPingMembers:\n - ' '\ndiscordPingRoles:\n - ' '\n\nenableBungeeCordSendMessage: true\nenableBungeeCordReceiveMessage: true\n\nuseTitleInsteadOfMessage: false\nenablePlayerHeads: true\nrefreshPlayerHeadCache: 1d # Default, 1m, 1h, 1d, 1w, 1mo, 1y\n\nmetrics: true # Enables or disables metrics\nserverName: \"My Server\"\n\nmax-reports-per-player: 25 # 0 = unlimited\nreport-confirmation-message: Thanks for submitting a report!\nbug-report-cooldown: 0 # 0 = disabled\n\n# # Available placeholders:\n#\n# Aqua, Black, Blue, Dark_Aqua, Dark_Blue\n# Dark_Gray, Dark_Green, Dark_Purple, Dark_Red\n# Gold, Gray, Green, Light_Purple, Red, White, Yellow\npluginColor: Yellow\n\n# You are able to use & for color codes such as \"&8[&6Bug Report&8]&9\".\n# For a list of color codes, visit https:\/\/htmlcolorcodes.com\/minecraft-color-codes (Format Codes will NOT work!)\n# This will override the pluginColor option.\npluginTitle: '[Bug Report]'\n\n# This can either be \"mysql\" or \"local\".\n# If you choose \"mysql\", you must fill out the database section below.\n# If you choose \"local\", no configuration is required.\ndatabaseType: local\ndatabase:\n host: localhost\n port: 3306\n database: database\n username: root\n password: password\n\n# Placeholders via PlaceholderAPI are allowed to be used in the discordEmbedFields.\n# E.g: You can create a field with the biome of the player, where the bugreport was created.\n# Choose for the value: \"%player_biome%\" (without \"\"). This works with any other Placeholder supported by PlaceholderAPI.\ndiscordEmbedFields:\n - name: \"Username\"\n id: 1\n value: \"%report_username%\"\n inline: true\n - name: \"UUID\"\n id: 2\n value: \"%report_uuid%\"\n inline: true\n - name: \"World\"\n id: 3\n value: \"%report_world%\"\n inline: true\n - name: \"Location (X, Y, Z)\"\n id: 4\n value: \"%report_location%\"\n inline: true\n - name: \"Gamemode\"\n id: 5\n value: \"%report_gamemode%\"\n inline: true\n - name: \"Status\"\n id: 6\n value: \"%report_status%\"\n inline: true\n - name: \"Category\"\n id: 7\n value: \"%report_category%\"\n inline: true\n - name: \"Sever Name\"\n id: 8\n value: \"%report_server_name%\"\n inline: true\n - name: \"Full Message\"\n id: 9\n value: \"%report_full_message%\"\n inline: false\n\nreportCategories:\n - name: Plugin Bug\n id: 1\n description: Report a bug with a plugin\n item: minecraft:book\n color: red\n - name: Server Bug\n id: 2\n description: Report a bug with the server\n item: minecraft:emerald\n color: green\n - name: Resource Bug\n id: 3\n description: Report a bug with the resource pack\n item: minecraft:map\n color: blue\n - name: Other\n id: 4\n description: Report something else\n item: minecraft:paper\n color: yellow\n\nstatuses:\n - name: Open\n description: Report is open\n icon: minecraft:green_dye\n color: GREEN\n id: 1\n - name: Archived\n description: Report is archived\n icon: minecraft:red_dye\n color: RED\n id: 2\n - name: Pending\n description: Report is pending\n icon: minecraft:yellow_dye\n color: YELLOW\n id: 3\n - name: Ignored\n description: Report is ignored\n icon: minecraft:white_dye\n color: WHITE\n id: 4\n```\n\n## Languages File\nThe new languages files can be viewed here - https:\/\/github.com\/ItsLeon15\/Bug-Reports\/tree\/main\/src\/main\/resources\/languages\n\n## Metrics Collection\nBug Report uses **bStats** to collect anonymous statistics about servers. If you would like to disable metrics collection, you can do so by editing the **plugins\/bStats\/config.yml** file.\n<\/p>\n","protected":false},"excerpt":{"rendered":"