Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onelitefeathernet/plugin-debug
A simple library to upload plugin debugs for developer to fix bugs easier
https://github.com/onelitefeathernet/plugin-debug
api bukkit debug debugging hacktoberfest libary minecraft-plugin-development plugin
Last synced: 3 months ago
JSON representation
A simple library to upload plugin debugs for developer to fix bugs easier
- Host: GitHub
- URL: https://github.com/onelitefeathernet/plugin-debug
- Owner: OneLiteFeatherNET
- License: agpl-3.0
- Created: 2023-05-01T10:49:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T00:31:49.000Z (5 months ago)
- Last Synced: 2024-10-30T05:42:33.765Z (3 months ago)
- Topics: api, bukkit, debug, debugging, hacktoberfest, libary, minecraft-plugin-development, plugin
- Language: Java
- Homepage: https://discord.onelitefeather.net
- Size: 385 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Plugin Debug
[](https://javadoc.io/doc/dev.themeinerlp/plugin-debug)
## Description
Plugin Debug is a simple and modern library for collect some debug information of your plugin.
This library is inspired by Debug Paste of @IntellectualSites [IntellectualSites](https://github.com/IntellectualSites)
As a backend we use from lucko [bytebin](https://github.com/lucko/bytebin) service to host/upload the debug files
## Motivation
We maintain now more than one plugin/software plugin in java. Now it's time to build an api/library to help us to provide better support for users there use our plugins.
## Focus
Our focus lies within a basic implementation of a generic api for collect server information and upload to a (custom) [bytebin](https://github.com/lucko/bytebin) server .
## More information / external links
Discord: https://discord.onelitefeather.de
## Get started
Groovy
```groovy
dependencies {
// Core
implementation 'dev.themeinerlp:plugin-debug:1.0.0'
// Bukkit Extension
implementation 'dev.themeinerlp.plugin-debug:bukkit-extension:1.0.0'
}
```
Kotlin DSL
```kotlin
dependencies {
// Core
implementation("dev.themeinerlp:plugin-debug:1.1.0")
// Bukkit Extension
implementation("dev.themeinerlp.plugin-debug:bukkit-extension:1.1.0")
}
```
### Example
We have an example [gradle module](example) with an example bukkit command to retrieve a debug log.
Also, we provide already a pre-hosted web ui for view your logs.
The hosted ui follows this structure:
```
https://debugpaste.onelitefeather.net/#/BYTEBIN_CODE/ENCODED_URL/
```
* BYTEBIN_CODE
* The returned code from ByteBin Server when the upload is successfully
* ENCODED_URL
* The ByteBin Server URL encoded in a friendly style
---
### Example code(Kotlin):
```kt
// Example json object from GSON LIB
val obj = JsonObject()
obj.addProperty("Test", "Test")
val result =
DebugBuilder.builder(BYTEBIN_BASE_URL)
// Adds a file from path wrapped in a placeholder object
.addFile(DebugFile(Path.of("config", "config.yml"), FileType.YAML, "Config as file object"))
// Add a simple text to the debug
.addText("Text test", "Text test")
// Add json formatted string to the debug
.addJson(Gson().toJson(obj), "Json test")
// Upload to a bytebin server
.upload()
// Encodes the URL as string
val encodedUrl = URLEncoder.encode(
result.uploadServer,
StandardCharsets.UTF_8
)
// ByteBin Code from Server
val code = result.code
// Prettified url
val openUrl = "https://debugpaste.onelitefeather.net/#/$code/$encodedUrl/"
val component = MiniMessage.miniMessage().deserialize("<#05b9ff>[Example] Click here to open the debug paste")
```