From 6d4cffed16952ff7d008a19906df02424ef734e2 Mon Sep 17 00:00:00 2001 From: Tom Hicks Date: Wed, 23 Sep 2026 21:36:27 -0700 Subject: [PATCH] Adds project description docs. --- .gitignore | 3 ++- .vscode/settings.json | 15 +++++++++------ ProjectDescription.json | 23 +++++++++++++++++++++++ ProjectDescription.md | 16 ++++++++++++++++ 4 files changed, 50 insertions(+), 7 deletions(-) create mode 100644 ProjectDescription.json create mode 100644 ProjectDescription.md diff --git a/.gitignore b/.gitignore index 2793e0a..7428a22 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .gradle/ build/ target/ -.worktrees +.worktrees/ +bin/ diff --git a/.vscode/settings.json b/.vscode/settings.json index 90d61f8..e9fad8d 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,7 +1,10 @@ { - "[java]": { - "editor.formatOnSave": true - }, - "java.configuration.updateBuildConfiguration": "interactive", - "java.compile.nullAnalysis.mode": "automatic" -} \ No newline at end of file + "[java]": { + "editor.formatOnSave": true + }, + "java.configuration.updateBuildConfiguration": "interactive", + "java.compile.nullAnalysis.mode": "automatic", + "chat.tools.terminal.autoApprove": { + "printf": true + } +} diff --git a/ProjectDescription.json b/ProjectDescription.json new file mode 100644 index 0000000..b8f4d3a --- /dev/null +++ b/ProjectDescription.json @@ -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": "" + } +} diff --git a/ProjectDescription.md b/ProjectDescription.md new file mode 100644 index 0000000..c38bff5 --- /dev/null +++ b/ProjectDescription.md @@ -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.