Adds project description docs.

This commit is contained in:
2026-09-23 21:36:27 -07:00
parent 16be005595
commit 6d4cffed16
4 changed files with 50 additions and 7 deletions

3
.gitignore vendored
View File

@@ -1,4 +1,5 @@
.gradle/
build/
target/
.worktrees
.worktrees/
bin/

15
.vscode/settings.json vendored
View File

@@ -1,7 +1,10 @@
{
"[java]": {
"editor.formatOnSave": true
},
"java.configuration.updateBuildConfiguration": "interactive",
"java.compile.nullAnalysis.mode": "automatic"
}
"[java]": {
"editor.formatOnSave": true
},
"java.configuration.updateBuildConfiguration": "interactive",
"java.compile.nullAnalysis.mode": "automatic",
"chat.tools.terminal.autoApprove": {
"printf": true
}
}

23
ProjectDescription.json Normal file
View File

@@ -0,0 +1,23 @@
{
"id": "scorekeeper",
"title": "ScoreKeeper",
"description": "Paper Minecraft plugin for tracking and managing player scores.",
"docId": "ScoreKeeper",
"image": {
"url": "https://image.pollinations.ai/prompt/pixel%20art%20Minecraft%20server%20scoreboard%20with%20a%20glowing%20diamond%20and%20number%20counters%2C%20clean%20square%20game%20plugin%20thumbnail%2C%20no%20text",
"alt": "Pixel art scoreboard with a diamond for the ScoreKeeper Minecraft plugin",
"prompt": "Pixel art Minecraft server scoreboard with a glowing diamond and number counters, clean square game plugin thumbnail, no text",
"width": 1024,
"height": 1024,
"backgroundClassName": "bg-surface"
},
"url": "/projects/scorekeeper",
"tags": [],
"source": {
"type": "",
"url": ""
},
"feedback": {
"url": ""
}
}

16
ProjectDescription.md Normal file
View File

@@ -0,0 +1,16 @@
# ScoreKeeper
ScoreKeeper is a Paper Minecraft plugin for tracking player scores during server activities, events, or games. It keeps scores per player in memory and exposes commands for viewing, changing, resetting, and archiving scores.
## Details
- Built for Paper API 1.21.7 with Java 21 and Gradle.
- Registers `/score-get`, `/score-add`, `/score-subtract`, `/score-reset`, and `/score-archive`.
- Commands use the executing player when a player name is omitted.
- Scores are currently held in memory and are not persisted when the server stops.
- Score archiving is planned, but the current implementation reports that archiving is unavailable.
- The project is packaged as a Java plugin with a `plugin.yml` descriptor.
## Image
No project image asset is included in the repository. The JSON description includes a prompt-backed image URL for a future project thumbnail.