Badge request: Sponge plugin
- Dominant language
- JavaScript
- Stars
- 27.2k
- Forks
- 5.6k
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 46
Description
:clipboard: **Description**
These badges would be for [Sponge](https://spongepowered.org/) plugins via [Ore](https://ore.spongepowered.org). They would be in the following formats (taking [LuckPerms](https://ore.spongepowered.org/Luck/LuckPerms) as an example):
[](http://ore.spongepowered.org/Luck/LuckPerms) [](http://ore.spongepowered.org/Luck/LuckPerms/versions/4.2.17) [](https://github.com/lucko/LuckPerms/blob/master/LICENSE.txt) [](https://ore.spongepowered.org/Luck/LuckPerms/stars) [](https://ore.spongepowered.org/Luck/LuckPerms) [](https://ore.spongepowered.org/Luck/LuckPerms)
:link: **Data**
Ore's public API is documented [here](https://ore.spongepowered.org/api/). There's no API key required, although it requires a session to be created.
LuckPerms's API response looks like this:
URL:
```
{
"created_at": "2017-02-01T18:58:17.19",
"plugin_id": "luckperms",
"name": "LuckPerms",
"namespace": {
"owner": "Luck",
"slug": "LuckPerms"
},
"promoted_versions": [
{
"version": "4.2.17",
"tags": [
{
"name": "Sponge",
"data": "8.0.0-SNAPSHOT",
"display_data": "8.0",
"minecraft_version": null,
"color": {
"foreground": "#333333",
"background": "#F7Cf0D"
}
}
]
},
{
"version": "4.1.7",
"tags": [
{
"name": "Sponge",
"data": "6.0.0",
"display_data": "6.0",
"minecraft_version": null,
"color": {
"foreground": "#333333",
"background": "#F7Cf0D"
}
}
]
},
{
"version": "3.0.14",
"tags": [
{
"name": "Sponge",
"data": "5.0.0",
"display_data": "5.0",
"minecraft_version": null,
"color": {
"foreground": "#333333",
"background": "#F7Cf0D"
}
}
]
}
],
"stats": {
"views": 56378,
"downloads": 20231,
"stars": 81
},
"category": "admin_tools",
"description": "An advanced permissions plugin",
"last_updated": "2019-12-27T23:50:23.984",
"visibility": "public",
"user_actions": {
"starred": false,
"watching": false
},
"settings": {
"homepage": null,
"issues": "https://github.com/lucko/LuckPerms/issues",
"sources": "https://github.com/lucko/LuckPerms",
"support": null,
"license": {
"name": "MIT",
"url": "https://github.com/lucko/LuckPerms/blob/master/LICENSE.txt"
},
"forum_sync": true
},
"icon_url": "https://ore.spongepowered.org/Luck/LuckPerms/icon"
}
```
:microphone: **Motivation**
Sponge is a platform for server-side modding of Minecraft servers, and is Spigot's main competitor in that field. shields.io already has great badges for Spigot plugins via Spiget, but no such badges for Sponge plugins via Ore (the official plugin repository). This would allow Sponge plugin developers to display information in badge format about their Sponge plugins on GitHub or a documentation site.
Contributor guide
Research direction
Start by reviewing the existing Spiget badge integration mentioned in the issue, then compare it with the Ore API documentation and the example response at /api/v2/projects/luckperms. The work is done when Sponge plugin badges expose the requested platform, version, license, stars, downloads, and category data using Ore.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100