{"id":17040358,"url":"https://github.com/carlgo11/report","last_synced_at":"2025-09-02T03:33:27.065Z","repository":{"id":13956592,"uuid":"16656839","full_name":"Carlgo11/report","owner":"Carlgo11","description":"Upload bukkit logs + plugin logs to pastebin.com","archived":false,"fork":false,"pushed_at":"2019-12-27T16:12:12.000Z","size":67,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T00:41:44.302Z","etag":null,"topics":["bukkit-plugin","bukkit-plugins","java","minecraft-plugin","pastebin"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Carlgo11.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-02-09T00:52:20.000Z","updated_at":"2022-04-04T04:15:35.000Z","dependencies_parsed_at":"2022-09-16T09:21:06.604Z","dependency_job_id":null,"html_url":"https://github.com/Carlgo11/report","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Carlgo11/report","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carlgo11%2Freport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carlgo11%2Freport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carlgo11%2Freport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carlgo11%2Freport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Carlgo11","download_url":"https://codeload.github.com/Carlgo11/report/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carlgo11%2Freport/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273225309,"owners_count":25067265,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bukkit-plugin","bukkit-plugins","java","minecraft-plugin","pastebin"],"created_at":"2024-10-14T09:09:30.931Z","updated_at":"2025-09-02T03:33:27.041Z","avatar_url":"https://github.com/Carlgo11.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Report-API\n[![Build Status](https://img.shields.io/github/workflow/status/Carlgo11/report/Java%20CI?style=for-the-badge)](https://github.com/Carlgo11/report/actions)\n[![License](https://img.shields.io/github/license/carlgo11/report?style=for-the-badge)](https://github.com/Carlgo11/report/blob/master/LICENSE.md)\n![Bukkit](https://img.shields.io/badge/bukkit-v1.15.1-ab7b53?style=for-the-badge)\n\nUpload server logs \u0026 plugin configurations for bug reports.\n\n## Installation\n\nAdd this to your pom.xml:\n\n```XML\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.carlgo11\u003c/groupId\u003e\n  \u003cartifactId\u003ereport\u003c/artifactId\u003e\n  \u003cversion\u003e1.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nRun via command line:\n```BASH\nmvn install\n```\n\nimport the Report class in your own class:\n```JAVA\nimport com.carlgo11.report.Report;\n```\n\nGo to [Pastebin.com](https://pastebin.com) and create an account if you haven't already.  \nThen go to [Pastebin API](https://pastebin.com/api#1), retrieve your API key and optionally your [User Key](https://pastebin.com/api/api_user_key.html).\n\n### Plugin dependency\nAs your plugin will have to load after the Report-API has finished loading it's a good idea to make that clear in the `plugin.yml` of your plugin. This can be done through several ways.\n  \n #### Hard dependency\nThe first one is to require Report-API to be present for your plugin do load:\n```YAML\ndepend:\n  - report-api\n```\n\n#### Soft dependency\nIf you'd rather have the report feature as an optional functionality you can use the soft depend tag:\n```YAML\nsoftdepend:\n  - report-api\n```\nThis way the server will try and load Report-API before your own plugin if Report-API is present in the plugins folder.\nIf not, it will just load your plugin normally.\n\n## Usage\n\nTo generate a report, call the Report class like this:\n```JAVA\nString api_key = \"\"; //Pastebin API key\nString user_key = \"\"; //Pastebin User key (can be left blank)\n\nReport report = new Report(plugin, user_key, api_key); //Call Report class\nreport.makeReport(); //Send the data away to Pastebin\n```\n\nYou can then send the URL to the user who sent the request.\n\n```JAVA\nURL url = report.getURL(); //Get the Pastebin URL\nsender.sendMessage(\"Give this URL to the support agent: \" + URL.toString);\n```\n\n### Optional code\nIt's a good idea to also check that the `makeReport()` function returns true and that the `getURL()` function returns a valid Pastebin URL.\n```JAVA\nString api_key = \"\";\nString user_key = \"\";\ntry {\n    Report report = new Report(plugin, user_key, api_key);\n    if(report.makeReport()){\n        URL url = report.getURL();\n        if(url.toString().startsWith(\"https://pastebin.com/\")){\n            sender.sendMessage(\"Give this URL to the support agent: \" + url.toString);\n        }\n    }\n} catch (ClassNotFoundException e) {\n    System.out.println(\"Report-API not installed!\");\n}\n```\n\n\n## Compile locally\nTo compile Report-API locally you need:\n* Java JDK 8 or later\n* Apache Maven\n\nThen run:\n```BASH\nmvn install\n```\n_Depending on your OS and Maven setup you might need to replace `mvn` with `maven` in the example above_.\n\nYou should now have a Report-API JAR-file inside the `target` folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlgo11%2Freport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarlgo11%2Freport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlgo11%2Freport/lists"}