diff --git a/.gitignore b/.gitignore index 998743b..7428a22 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .gradle/ build/ target/ -bin +.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/Project.md b/Project.md new file mode 100644 index 0000000..4b90f9d --- /dev/null +++ b/Project.md @@ -0,0 +1,280 @@ +# ScoreKeeper — Project Reference + +> **For a developer joining the team cold.** Read top-to-bottom in ~8 minutes; +> you'll know where to look and what's real vs. planned on day one. + +--- + +## 1. What is ScoreKeeper? + +ScoreKeeper is a **Paper Minecraft plugin** (Java 21, Bukkit/Adventure APIs) that manages player +score tracking. It exposes five in-game/console commands (`/score-get`, `/score-add`, +`/score-subtract`, `/score-reset`, `/score-archive`) for manual score manipulation — no events, +no timers, no automation. + +**State of the project:** live in-memory scores work today; the \"high-score table\" advertised +in the README name and `/score-archive` description is **not implemented**. Persistence, ranking, +and scoring formulas are all **future scope**. See §4 for the gap between *what exists* and +*what is planned*. + +--- + +## 2. Tech Stack & Build + +| Item | Value | +|------|-------| +| Language | Java 21 (Gradle auto-downloads toolchain) | +| Runtime target | Paper 1.21.7 (Bukkit + Adventure APIs) | +| Build tool | Gradle 8.14.3 (`gradlew`) | +| Linting | Spotless (`googleJavaFormat()` + license header from `config/license-header.txt`) | +| Release | `net.researchgate.release` plugin; tags `v$version`; rejects snapshot deps except paper-api | +| External deps | **None at runtime.** `paper-api:1.21.7-R0.1-SNAPSHOT` is `compileOnly` only. | +| CI/release entry point | `./gradlew spotlessCheck build` then `./gradlew release` | + +### Build quickly + +```bash +./gradlew build # compiles, runs tests (none yet) +./gradlew spotlessApply # format to project style +./gradlew assemble # produces jar in build/libs/ +``` + +Drop the resulting jar onto a Paper server's `plugins/` directory. + +--- + +## 3. Architecture Overview + +### Directory layout + +``` +├── src/main/java/com/majinnaibu/minecraft/plugins/scorekeeper/ +│ ├── ScoreKeeperPlugin.java ← entry point, onEnable/onDisable, score CRUD core +│ └── commands/ +│ ├── ScoreGetCommand.java → /score-get [player] +│ ├── ScoreAddCommand.java → /score-add [player] +│ ├── ScoreSubtractCommand.java → /score-subtract [player] +│ ├── ScoreResetCommand.java → /score-reset [player] +│ └── ScoreArchiveCommand.java → /score-archive [player] (stub) +├── src/main/resources/ +│ └── plugin.yml ← command manifest + main-class declare +├── tools/bash/ & tools/powershell/ ← dev helper scripts +├── config/license-header.txt ← Spotless license header +├── build.gradle ← Gradle build config (above) +├── gradle.properties ← version, group coordinates +├── CONTRIBUTING.md ← dev env setup +└── README.md ← user-facing command reference + notes +``` + +### Data flow (text diagram) + +``` +ADMIN / CONSOLE / RCON ──▶ types a /score-* command + │ + ▼ + ┌──────────────────────┐ + │ 5× Score*Command.java│ executors parse args, + │ resolves target │ resolvePlayerExact(name) (online-only) + └──────────┬───────────┘ + │ calls + ▼ + ┌──────────────────────────────┐ + │ ScoreKeeperPlugin │ + │ │ + │ addScore / subtractScore │ read-modify-write + │ resetScore / setScore │ + │ getScore (read) │ + │ archiveScore (STUB — no-op) │ + └──────────┬───────────────────┘ + │ + ▼ + HashMap ← in RAM only + _playerScores ← ScoreKeeperPlugin:38 +``` + +**Key architectural facts:** + +- **Single class owns everything.** `ScoreKeeperPlugin` holds the scores map, score CRUD + methods, logging helpers (logWarning/logInfo/logError), and the Adventure component builder + for chat color. There is no service layer or boundary separation. +- **No event listeners.** Zero `@EventHandler`/`Listener` registrations across the codebase. + Game events (join, death, kill) do not affect scores. Only manual commands change state. +- **No scheduler or tick logic.** No periodic tasks, no countdowns, no automated scoring. +- **No permission nodes.** Every command is available to every sender (player, console, RCON). + +### File: ScoreKeeperPlugin.java (`ScoreKeeperPlugin`) + +- `main` class in `plugin.yml` (Bukkit plugin entry point) +- `HashMap _playerScores` at line 38 — the sole score store +- `onEnable()` (line 52): wires five command executors, logs \"load not implemented\" warning +- `onDisable()` (line 46): logs \"save not implemented\" warning — scores lost on shutdown +- Score CRUD methods: `addScore`, `subtractScore`, `resetScore`, `setScore`, `getScore`, + `archiveScore` (lines 67–91, 76–86, 72–74) +- Private helpers: `getPlayerScore(Player)` (get-or-create at 0), `setPlayerScore(Player,int)` + +--- + +## 4. Domain Model & Scoring Logic + +### 4.1 What exists today (REAL — in code) + +| Aspect | Detail | Source | +|--------|--------|--------| +| Score model | Single `int` per player, keyed by UUID | `ScoreKeeperPlugin:38` | +| Storage container | `HashMap` on plugin instance | same file | +| Default value | `0` — lazy-created on first map access | `getPlayerScore:100-106` | +| Live only | **No persistence.** Scores erased on server restart | `onEnable:59`, `onDisable:47` | +| Scoring direction | Any integer (negatives allowed, no floor) | add/subtract are raw `+`/`-` | +| Recording method | Manual commands only — `/score-add`, `/score-subtract` | command executors | +| Auto-scoring | **None** — no events, no timers | proven by grep across src/ | +| Permissions | **None declared.** All commands open to all senders | `plugin.yml`, no permission guard in code | + +### 4.2 Open Score Lifecycle (what exists + what is planned) + +``` +Stage 1. First access — getPlayerScore() auto-creates key at 0 [REAL] + 2. Admin runs /score-add player N or /score-subtract [REAL] + 3. Player accumulates points over the session [REAL] + 4. Read via /score-get (read-only, lazily registers) [REAL] + 5. Server restart — scores LOST on shutdown [REAL] + 6. Intended: /score-archive freezes score → table [GAP ✓ not built] + 7. Intended: high-score table display command [GAP ✓ not built] +``` + +### 4.3 The "high-score table" — status + +| Feature | Status | Details | +|---------|--------|---------| +| `/score-archive` | **Stub** | Command prints \"archive command unimplemented\"; `archiveScore()` method only logs, never writes a table or resets the player's score | +| Persistence (save) | **Not built** | `onDisable()` is a TODO stub — map discarded at shutdown | +| Persistence (load) | **Not built** | `onEnable()` is a TODO stub — map always starts empty `{}` | +| Sorting / ranking | **Not coded** | No sort, no tie-breaking, no entry cap, no decay logic exists | +| Scoring formulas | **Not coded** | Scores are plain integer accumulators (`Σ(adds) − Σ(subtracts)`) | + +**Design decisions to be made (none answered by code today):** + +- Storage format for the table (YAML per Bukkit convention; JSON? SQLite?) +- What an entry looks like (name + score + timestamp? name is not stored with score today) +- Sort order and tie-breaking strategy +- Max entries / leaderboard cap +- Whether `/score-archive` also resets the live score (README says it does) + +--- + +## 5. Plugin Integration & Reference Table + +### 5.1 Command → Handler → Effect on score data + +| Trigger | Usage | Handler | Effect | +|---------|-------|---------|--------| +| `/score-get [player]` | Self or other | `ScoreGetCommand.java:38-84`, delegated to `getScore → getPlayerScore` | **Read-only.** Returns integer. Lazily creates entry at `0` if unseen. | +| `/score-add [player] ` | Self (omit name) or target others | `ScoreAddCommand.java` | `score += N`. Amount must parse as int. No direction validation (negative N still adds). | +| `/score-subtract [player] ` | Same | `ScoreSubtractCommand.java` | `score -= N`. No minimum clamping; negatives freely produced. | +| `/score-reset [player]` | Same | `ScoreResetCommand.java` | `score = 0`. Key created at `0` if absent. | +| `/score-archive [player]` | Same | `ScoreArchiveCommand.java` | **No-op.** Prints \"archive command unimplemented\". Does NOT call the `archiveScore()` method. | + +### 5.2 Shared behavior details + +Every executor follows this pattern: + +1. Parse arguments — if `split.length == 1` and sender is a player, target = self (RCON/console + requires an explicit `` or prints usage). +2. Resolve target player via `server.getPlayerExact(name)` — **exact, case-sensitive, online-only.** +3. Call the corresponding `ScoreKeeperPlugin` method. +4. Echo color-coded result; return `true`. + +### 5.3 Inter-plugin / public API surface + +`ScoreKeeperPlugin` exposes these public methods that other plugins *could* call if they hold a reference +(but there is **no formal service registration**): + +| Method | Visibility | Called by commands? | Notes | +|--------|------------|---------------------|-------| +| `addScore(Player, int)` | `public` | Yes (`/score-add`) | Read-modify-write on `_playerScores` | +| `subtractScore(Player, int)` | `public` | Yes (`/score-subtract`) | Same pattern | +| `getScore(Player)` | `public` | Yes (`/score-get`) | Wrapper around `getPlayerScore` | +| `setScore(Player, int)` | `public` | **No** | Internal write path only; not hooked to any command | +| `resetScore(Player)` | `public` | Yes (`/score-reset`) | Sets to `0` | +| `archiveScore(Player)` | `public` | **No** | Only logs a warning; never called by the archive command | + +### 5.4 Concurrency note + +The map is a plain `HashMap`. Safe because Paper dispatches commands on the server's single main +thread — but it is **not safe for off-thread use**. Any future event-driven scoring that runs +asynchronously could corrupt state via non-atomic read-modify-write. + +--- + +## 6. Configuration Reference + +| File | Format | Purpose | +|------|--------|---------| +| `plugin.yml` | YAML (Bukkit manifest) | Declares main class, api-version, five commands + descriptions/usage strings | +| `build.gradle` | Gradle Kotlin (Groovy DSL) | Dependencies, task config, release/spotless settings | +| `gradle.properties` | Properties | Project version and group coordinates (for Maven publishing) | +| **No `config.yml`** | — | ScoreKeeper has **no player-editable configuration**. | +| **No `permissions:` block** | — | No permission nodes declared; all commands are open. Plans say \"permissions coming after archive works.\" | + +--- + +## 7. Running & Testing Locally + +### Build + +```bash +./gradlew assemble # produces ScoreKeeper.jar in build/libs/ +``` + +### Run locally (Paper server) + +1. Download Paper 1.21.7 from `https://papermc.io` +2. Copy the built jar into `plugins/` +3. Start the server, verify onEnable logs: + ``` + [ScoreKeeper] ScoreKeeper version X.Y.Z is enabled. + [ScoreKeeper] Unable to load scores from file. This feature is not implemented yet. + ``` + +### Commands (in-game or via RCON/console) + +| Test scenario | Command | Expected output | +|--------------|---------|-----------------| +| Check own score | `/score-get` | \"Your score is 0\" (creates entry at 0) | +| Add points to self | `/score-add 10` | \"You gained 10 points! Now have 10.\" | +| Subtract from self | `/score-subtract 5` | \"You lost 5 points! Now have 5.\" | +| Check another player | `/score-get PlayerName` | \"PlayerName's score is N.\" (must be online) | +| Reset own score | `/score-reset` | \"Your score has been reset to 0.\" | +| Archive (stub) | `/score-archive` | \"archive command unimplemented\" | + +### Tests + +- **No unit/integration tests exist yet.** `./gradlew test` runs an empty suite. Consider + adding tests for `ScoreKeeperPlugin`'s private `Player` score state mocking in a future task. + +--- + +## 8. Where to Look First + +| I want to understand… | Go to | +|----------------------|-------| +| The entire live data model | `ScoreKeeperPlugin:38` — one `HashMap` field | +| How scores change (write path) | `addScore(/:67-70)`, `subtractScore(/:88-91)`, `setPlayerScore(/:108-110)` | +| How a player is looked up | `getPlayerExact(name)` online only — see any `*Command.java` line ~50 | +| First-time-player behavior | `getPlayerScore(/:100-106)` — auto-inserts `0` on first access | +| High-score / archive table | **Does not exist.** See `archiveScore(/:72-74)` stub; design decisions in §4.3 | +| Persistence (save/load) | `onDisable(/:47)`, `onEnable(/:59)` — both TODO, nothing writes to disk | +| What's declared/intended but not wired | `plugin.yml:18-20` (`/score-archive`), `README.md:11` and README notes | +| Command implementations | `commands/Score*Command.java` (all 5 handlers) | +| Build/runtime config | `build.gradle`, `plugin.yml`, `gradle.properties` | +| Dev env / CONTRIBUTING | `CONTRIBUTING.md` | +--- + +## Appendix: Risk Summary + +| # | Issue | Impact | Section | +|---|-------|--------|---------| +| 1 | **Data loss on restart** — no save/load implemented | Every server boot wipes all scores (§4.1) | §4.1 | +| 2 | **No permissions** — any player can self-add points | Integrity of scoring is unenforceable today (§5.2) | §5.2 | +| 3 | **Race condition on add/subtract** — non-atomic read-modify-write on plain `HashMap` | Corrupt state if future event-driven scoring runs async (§5.4) | §5.4 | +| 4 | **No `int` overflow safety** — Java wrapping semantics apply | Undetectable score corruption near ±2.1 billion | §4.1 | +| 5 | **Name lookups online-only & case-sensitive** | Can't target offline players; \"Alice\" ≠ \"alice\" (§5.2) | §5.2 | diff --git a/build.gradle b/build.gradle index 9ef68f2..46b4d4c 100644 --- a/build.gradle +++ b/build.gradle @@ -43,7 +43,8 @@ publishing { } release { - buildTasks.addAll(['spotlessCheck', 'build']) +// buildTasks.addAll(['spotlessCheck', 'build']) + buildTasks = ['spotlessCheck', 'build'] failOnSnapshotDependencies = true ignoredSnapshotDependencies = [ "io.papermc.paper:paper-api" diff --git a/docs/domain-score-tracking.md b/docs/domain-score-tracking.md new file mode 100644 index 0000000..1fa4ad8 --- /dev/null +++ b/docs/domain-score-tracking.md @@ -0,0 +1,365 @@ +# ScoreKeeper — Score-Tracking & "High-Score Table" Domain Analysis + +> **Scope of this document:** the domain logic that tracks player scores and (intended) the +> high-score table. Written for a new team member who must understand the scoring system +> *without opening the source*. Every claim below is traced to a file/line so it can be +> re-verified. +> +> **Bottom line up front (read this first):** ScoreKeeper currently tracks **live scores +> only, in memory, for the running server session**. It has **no persistence** and **no +> high-score table**. The high-score table is *described as a planned feature* in the +> README and is where the `/score-archive` command is *intended* to land scores, but +> **that code path is an unimplemented stub today.** There is no sorting, no tie-breaking, +> no entry cap, no decay, and no scoring formula/weighting anywhere in the codebase. +> This is a greenfield/early-stage domain — the write-up documents the *real* state and +> flags the gap, because documenting features that don't exist as if they did would mislead +> the next engineer. + +--- + +## 0. How to read the rest of this doc against the task's four questions + +The task asks for (1) the score-entry data model + persistence format, (2) how scores are +recorded, (3) the high-score-table algorithm, and (4) scoring formulas/weighting. +For each question the answer is: **the mechanism that exists vs. the mechanism the project +intends**, so readers never conflate the two. + +| # | Question | Short answer | +|---|----------|--------------| +| 1 | Score-entry data model & persistence | Live score = `UUID -> int` in a `HashMap`. **No persistence** (load/save are `TODO` stubs). | +| 2 | How scores are recorded | **Manual, event-free:** the *administrator* runs a command. No game events, no timers. | +| 3 | High-score-table algorithm | **Not implemented.** No sort/tie-break/cap/decay. Only an aspirational `/score-archive`. | +| 4 | Scoring formulas / weighting | **None.** Scores are plain integer accumulators; no weighting, no decay, no bonuses. | + +--- + +## 1. The score-entry data model & persistence *(task Q1)* + +### 1.1 What a "score entry" actually is (current reality) + +The entire live-score domain is **one field** in the plugin's entry-point class: + +- **File:** `src/main/java/com/majinnaibu/minecraft/plugins/scorekeeper/ScoreKeeperPlugin.java:38` +- **Declaration:** `private final HashMap _playerScores = new HashMap();` + +That is the whole model: + +| Aspect | Value | +|--------|-------| +| Record shape | A single `Integer` (the score), keyed by a player's `UUID`. | +| Key type | `java.util.UUID` — the player's `UniqueId`, *not* the name string. | +| Value type | `int` (Java `Integer`), autoboxed into the map. | +| Container | one `java.util.HashMap` on the plugin instance. | +| Uniqueness | one entry per `UUID`. A player can have exactly one live score at a time. | +| Default for a new player | `0` — see §3.1 ("first-time player" edge case). | + +There is **no `Score`/`ScoreEntry`/`PlayerStats` value class**, no timestamp, no +name stored alongside the score (name is looked up from the live server only — see §2.3), +and no secondary index. + +### 1.2 Persistence format: **none exists** + +Persistence is *intended* but *not built*. Three concrete stubs prove this: + +1. **On disable (server stop):** `ScoreKeeperPlugin.java:46-49` `onDisable()` logs + *"Unable to save scores to file. This feature is not implemented yet."* — the map + is **discarded** on shutdown; nothing is written. +2. **On enable (server start):** `ScoreKeeperPlugin.java:59-60` `onEnable()` logs + *"Unable to load scores from file. This feature is not implemented yet."* — the map + always starts **empty** `{}` every server start. +3. **Archive:** `ScoreKeeperPlugin.java:72-74` `archiveScore(Player)` logs + *"Unable to archive score for ."* and returns — the "save to high-score table" + action is a no-op. + +So there is **no SQLite, no JSON, no YAML, no flat file, no config.yml**. The only file on +disk that concerns scores is `plugin.yml` (the command manifest — it lists the commands but +stores no scores). A grep of the whole tree for `sql / json / yaml / saveResource / +YamlConfiguration / File / Files. / Gson / Jackson` finds **zero hits** other than the +TODO/log strings. + +**Persistence format today = "in RAM only, lost on server restart."** + +> Implication for a new engineer: any "who's the top player" question answered *across +> restarts* is impossible today. Scores reset to the map being empty on every server boot. + +--- + +## 2. How scores are recorded *(task Q2)* + +### 2.1 The recording model is **manual and command-driven — no events, no timers** + +Scores move only when an administrator (or console/RCON) **types a command**. There is: + +- **No** `implements Listener`, no `@EventHandler`, no `registerEvents(...)`, no + `getServer().getPluginManager().registerEvents(...)`. +- **No** scheduler: no `getScheduler()`, no `runTask`, no `Timer`. +- **No** automatic hook to game events (e.g. a player killing a mob or reaching a goal + awards points automatically — *nothing like that exists*). + +A grep for `EventListener|@EventHandler|Listener|Scheduler|runTask` across `src/` returns +**zero**. + +So "scoring" happens **on demand**, by a person, via one of the four mutating commands: + +| Command | Effect on the map | Source | +|---------|-------------------|--------| +| `/score-add [player] ` | `score += amount` | `ScoreKeeperPlugin.addScore` `:67-70` | +| `/score-subtract [player] ` | `score -= amount` | `ScoreKeeperPlugin.subtractScore` `:88-91` | +| `/score-reset [player]` | `score = 0` | `ScoreKeeperPlugin.resetScore` `:80-82` | +| `/score-archive [player]` | **intended** to snapshot to a high-score table and reset to 0; **actually a no-op** | `ScoreKeeperPlugin.archiveScore` `:72-74` | + +`/score-get [player]` is read-only (returns the score, §2.4). + +### 2.2 The add/subtract primitives (the only real "write" path) + +Both funnel through one private setter: + +``` +addScore(player, n) -> old = getPlayerScore(player); setPlayerScore(player, old + n) :67-70 +subtractScore(player,n)-> old = getPlayerScore(player); setPlayerScore(player, old - n) :88-91 +setScore(player, s) -> setPlayerScore(player, s) :84-86 +resetScore(player) -> setPlayerScore(player, 0) :80-82 +setPlayerScore(p, v) -> _playerScores.put(p.getUniqueId(), v) :108-110 +``` + +Notes a new engineer must internalize: + +- **Read-modify-write.** `addScore`/`subtractScore` read the current value, compute, write + back in two map operations. (There is no concurrency control — see §5 risks.) +- **`int` math.** Values are Java `int`; a score can go **negative** (there is no floor at + 0 — `/score-subtract 50` on a 10-score yields `-40`), and can overflow `int` only after + `~2.1e9` points, which is not a practical concern. +- **No validation of the direction.** The only validation is *syntactic*: the amount must + parse as an integer (see §2.3). + +### 2.3 Command surface (who/what is allowed to record a score) + +Every command executor lives in `src/main/java/.../scorekeeper/commands/` and shares one +shape: parse args, resolve the target player, call the `ScoreKeeperPlugin` method, return +`true` (consumed). Two behavioral details matter: + +- **Self-target default:** if a *player* runs a command and omits the name, they target + *themselves*: `targetPlayer = (Player) sender`. (e.g. `ScoreGetCommand.java:44`, + `ScoreAddCommand.java:48`, `ScoreResetCommand.java:47-49`.) +- **RCON/console path:** if the sender is **not** a player (console/RCON), a player name + is **required** — omitting it prints usage instead of acting + (`ScoreGetCommand.java:46-48`, `ScoreAddCommand.java:45-47`, + `ScoreResetCommand.java:44-46`). +- **Name resolution:** `getServer().getPlayerExact(name)` — **exact, case-sensitive** + lookup by the *currently online* name (`ScoreGetCommand.java:50`, + `ScoreAddCommand.java:57`, `ScoreResetCommand.java:50`). A name that is not online + yields `null` → "Can't find a player with that name". Note the *map key is a UUID*, but + *lookup by name only works while that player is online* — you cannot change an offline + player's score by name today. +- **No permission nodes anywhere.** `plugin.yml` declares no `permission:`/`permissions:` + and the code checks none. The README's note ("the commands aside from get are intended + for admins … Permissions support is coming") is **intent, not enforcement** — a vanilla + player can run `/score-add` today. + +### 2.4 Reading a score (`/score-get`) + +`ScoreGetCommand.java:38-84` → `ScoreKeeperPlugin.getScore(player)` → `getPlayerScore(player)` +(`ScoreKeeperPlugin.java:76-78, 100-106`). It returns the live integer (0 for a known-but- +unwritten player, which also *materializes* a 0 entry, see §3.1). Output formatting +("Your score is N" vs. "PLAYER's score is N") depends only on whether the sender is the +target or not — it carries no ranking or table. + +--- + +## 3. The high-score-table algorithm *(task Q3)* + +### 3.1 What exists: **nothing. It is aspirational.** + +There is **no high-score table, no ranking structure, no sort, no tie-break rule, no max +entry count, and no decay/rotation** anywhere in the codebase. The task's premise ("the +high-score table") reflects the **product intent** in the README, not the **code**. Concretely: + +- The README (`README.md:11`) says `/score-archive` *"Saves the player's score to a + 'High Scores' table and resets their current score to 0."* +- The manifest (`plugin.yml:18-20`) declares `/score-archive` with that very description. +- But the command is a stub: `ScoreArchiveCommand.java:37-39` (`onCommand` body) replies + *"archive command unimplemented"*, and the underlying `archiveScore` + (`ScoreKeeperPlugin.java:72-74`) only logs and returns — it neither writes a table nor + resets anything. + +Therefore the "algorithm" is: **no-op.** A new engineer asked to "implement the high-score +table" is starting from zero; the design questions in §3.2 are **open**, not answered by code. + +### 3.2 Open design questions the table must settle (no code today decides these) + +Since no implementation exists, these are *decisions to be made*, recorded here so the +implementation task doesn't reinvent the debate: + +- **Storage/persistence format.** The load/save TODOs (`:47`, `:59`) say "to file"; + `plugin.yml`/Bukkit convention favors YAML (`YamlConfiguration`), but JSON/SQLite are all + viable. **Unchosen.** Persisting to `data/` via `getDataFolder()` is the idiomatic Bukkit + path. +- **What an entry is.** Today a live score is just `{uuid -> int}`. A high-score entry + likely needs **player name + score + (timestamp?) + (date earned?)**. Name is *not* + currently stored with the score, so a durable table must capture the name at archive + time (a UUID-only entry can't render a leaderboard without the name being resolvable). +- **Sorting / ordering.** Almost certainly **descending by score**. +- **Tie-breaking.** Undefined. Candidate rules: by *score only*; by *earliest* archived + first (stable, time-ordered); by *name* (alphabetical); or "first to reach that score." +- **Max entries / cap.** Undefined. A leaderboard needs a cap (e.g. top 10 / top 30); + today there is no cap because there is no table. +- **Decay / rotation / time window.** None, and none described in docs — so the safe + default is **"scores are permanent, no decay."** +- **Reset semantics on archive.** README promises archive *resets to 0* *and* records. + `ScoreArchiveCommand` must decide: does archiving also reset? Does it allow multi-entries + (a player appearing more than once) or one row per player? All open. + +### 3.3 Full lifecycle of a score: creation → (intended) display on the high-score table + +This is the acceptance-criterion walk-through. Each stage is marked **[REAL]** (in code now) +or **[GAP]** (intended, not built). + +1. **Player joins / acts** — a score *doesn't* exist yet. First interaction with the map is + lazy (see stage 4a). **[REAL]** +2. **Admin records a score** — `admin: /score-add Alice 10`. Parsed in `ScoreAddCommand`, + routed to `addScore`. The first time this runs for Alice, `getPlayerScore` **creates** + her entry at 0 and returns it; then `10` is written. **[REAL]** +3. **Score accumulates** — later `/score-add Alice 5` → 15; `/score-subtract Alice 2` → 13; + `/score-reset Alice` → 0. All in the in-memory map, live only. **[REAL]** +4. **Read** — `/score-get Alice` → "Alice's score is 13". No ranking shown. **[REAL]** +5. **Server restart** — `onDisable` *cannot* save (stub), `onEnable` *cannot* load (stub); + the map is **lost**. Alice's 13 is gone; every score starts empty again. **[REAL] — + this is the current data-loss reality.** +6. **Intended: archive to the high-score table** — `admin: /score-archive Alice` should + freeze Alice's 13 into a durable, sorted leaderboard and reset her live score to 0, so + it survives restarts. **[GAP]** — currently returns "archive command unimplemented". +7. **Intended: display on the high-score table** — a command (not yet built) renders the + capped, sorted list. **[GAP]** — no such command, no structure to render. + +**Edge cases (explicitly, per the acceptance criteria):** + +- **First-time player / first write.** A player has no map entry until `getPlayerScore` is + called, which **inserts `0` on first access** (`ScoreKeeperPlugin.java:100-106`). So a + first `/score-add X 10` yields **10, not** `10 - 0` ambiguity, and a first `/score-subtract + X 3` yields **−3** (no minimum-0 clamp). A first `/score-get X` returns **0** and + *materializes* the entry at 0. This `get-or-create-0` behavior is the de-facto "first-time + player" rule. **[REAL]** +- **Ties.** **Undefined** because no table exists. When the table is built, decide a + tie-break (§3.2). No code today can observe or sort ties — `HashMap` gives no order. **[GAP]** +- **Table full.** **Undefined** because no cap exists. When a cap is introduced, decide + what happens to the displaced entry: drop it, or "rotate" it into overflow. No code + today enforces a maximum. **[GAP]** +- **Offline / unknown name.** `getPlayerExact(name)` returns `null` for anyone not + currently online or any misspelling → the command prints "Can't find a player with that + name" and changes nothing. You **cannot** archive or reset an *offline* player by name + today; by-UUID writes (if a future table stores names+UUIDs) would fix that. **[REAL]** +- **Negative / large scores.** No clamp; negatives allowed, `int` overflow only near + ~2.1 billion. **[REAL]** +- **Double-spawn / relogin.** Keyed by `UUID`, **not name**, so a name change or two + players sharing a name can't collide on the *live* map; but a *name* is never stored, + so a future table that only persists the UUID can later fail to render a name. + +--- + +## 4. Scoring formulas & weighting *(task Q4)* + +**None.** There is: + +- No formula, no multiplier, no combo/bonus/streak logic. +- No weighting between action types. +- No time-based decay or "points per game" normalization. + +Scores are **pure integer accumulators**: `score = Σ(adds) − Σ(subtracts)` over the session, +resettable to 0 by `/score-reset` (intended: on `/score-archive`). The only "arithmetic" in +the code is the `+`/`−` in `addScore`/`subtractScore` and the `0` floor written by +`resetScore`. `int` semantics apply (wrapping overflow; no checked arithmetic). Any +formula/weighting is a **future-design** decision, not encoded today. + +--- + +## 5. Data-flow diagram (text) + +``` + ADMINISTRATOR / CONSOLE / RCON (no game events, no scheduler, no auto-scoring) + │ types a command + ▼ + ┌─────────────────────────────┐ + │ command executors │ commands/Score*Command.java + │ parse args + resolve player│ getPlayerExact(name) ── must be ONLINE (name→UUID) + │ (self-target if player) │ no permission checks + └──────────────┬──────────────┘ + │ calls + ▼ + ┌───────────────────────────────────────────────┐ + │ ScoreKeeperPlugin (entry point; plugin.yml main)│ + │ │ + │ addScore / subtractScore / resetScore / setScore │ read-modify-write on... + │ getScore (read) archiveScore (STUB)│ + └──────────────┬───────────────────────┬──────────┘ + │ read-modify-write │ (intended: snapshot→table, reset 0) + ▼ ▼ + live map: HashMap ╳ NOT IMPLEMENTED + "score entry = one int per UUID" high-score table: + default 0, no clamp, in RAM only ─ no structure, no sort, + │ ─ no persistence, + ├─ READ: /score-get → "N" ─ no cap/decay + │ + └─ LIFECYCLE: + onEnable : load from file → TODO (stays {} ; lost on restart) + onDisable : save to file → TODO (map discarded at shutdown) + + PERSISTENCE: none │ SCORE FORMULA: none │ EVENTS/TIMERS: none │ + PERMISSIONS: none │ HIGH-SCORE TABLE: aspirational stub only +``` + +--- + +## 6. Quick reference — "where to look first" + +| I want to understand… | Go to | +|-----------------------|-------| +| The entire live data model | `ScoreKeeperPlugin.java:38` (one `HashMap`) | +| How a score changes | `addScore`/`subtractScore`/`resetScore`/`setScore` `:67-91` | +| How a score is read | `getScore` `:76-78` → `getPlayerScore` `:100-106` (note get-or-create-0) | +| The "high-score table" | **Doesn't exist** — see `archiveScore` stub `:72-74`; design open in §3.2 | +| Persistence (save/load) | `onDisable` `:46-49`, `onEnable` `:59-60` — both `TODO`, not built | +| Command behaviors | `commands/Score*Command.java` (self-target default; RCON requires a name; exact online-name lookup) | +| What's declared/intended but not wired | `plugin.yml:18-20` (`/score-archive`), `README.md:11`, `README.md` notes | +| Build/runtime target | `build.gradle` (paper-api 1.21.7, Java 21), `plugin.yml` (`api-version: 1.21`) | + +--- + +## 7. Risks a new engineer should know (correctness gaps in the *current* live domain) + +These are real, not future-work — flagging because the doc's job is to prevent a new +developer from assuming the system is more mature than it is: + +1. **Data loss on restart.** No save/load (`:47`, `:59`). Every server boot wipes all + scores. Any "leaderboard across sessions" is broken by design. +2. **No permissions.** Anyplayer can self-add points. README says this is by intent + ("coming after I get archive to work") but it is not enforced. +3. **Race condition on add/subtract.** `read → compute → write` is not atomic and the + `HashMap` is not thread-safe; concurrent command executions could lose an update. + (Low likelihood today since commands are serial on one thread, but it's a latent bug for + any async/event-driven scoring that gets added.) +4. **No minimum-0 / no validation of amount sign.** Subtracts produce negatives freely. +5. **Name lookups are online-only & exact.** Can't target offline players by name; + case-sensitive; "Alice" ≠ "alice". +6. **No high-score table.** The flagship advertised feature (`/score-archive` → "High + Scores" table) is a no-op; a new engineer must not expect ranking/persistence to work. + +--- + +## 8. Summary for the synthesizer (`Project.md` § "domain model & scoring logic") + +Distilled, code-grounded, and honest: + +- **Model:** one `int` per player `UUID`, held in `ScoreKeeperPlugin._playerScores` + (`HashMap`), default `0`. +- **Recording:** manual, admin-driven commands; **no events/timers**; no permission guard. +- **Persistence:** **none** — load/save are `TODO`; scores are lost on restart. +- **High-score table:** **does not exist** — `/score-archive` is a stub; sorting/tie-break/ + cap/decay are **undecided design items** (listed in §3.2). +- **Formula/weighting:** **none** — plain `int` accumulation. +- **Lifecycle:** create-on-first-access (0) → add/subtract/reset (live only) → read via + `/score-get` → *intended* archive+reset + table display **not built** → lost on restart. +- **Edge cases:** first-time/first-write ⇒ 0-or-delta, no floor; ties/table-full ⇒ undefined + (no table yet); offline/unknown name ⇒ "can't find", unchanged. + +Everything below the "high-score table" line of the README is **future work**, and the +write-up's job is to make that boundary explicit so the next team member isn't misled. diff --git a/docs/plugin-integration-and-event-wiring.md b/docs/plugin-integration-and-event-wiring.md new file mode 100644 index 0000000..f7501a6 --- /dev/null +++ b/docs/plugin-integration-and-event-wiring.md @@ -0,0 +1,166 @@ +# ScoreKeeper — Plugin Integration & Event/Command Reference + +> Analysis for the ScoreKeeper codebase. Scope: how the plugin hooks into the +> Minecraft (Paper) server runtime — event listeners, command registrations, +> scheduled/tick logic, and inter-plugin/API surface — with a table mapping each +> trigger → handler class → effect on score data. +> +> Platform: **Paper** (`io.papermc.paper:paper-api:1.21.7-R0.1-SNAPSHOT`), Java 21, +> Gradle. Main class: `com.majinnaibu.minecraft.plugins.scorekeeper.ScoreKeeperPlugin`. + +--- + +## 1. TL;DR for a new developer + +ScoreKeeper is almost entirely **command-driven**. It registers **no Bukkit event +listeners**, declares **no `@EventHandler` methods, no `Listener` implementations, +and calls `getPluginManager().registerEvents(...)` nowhere**. It also schedules +**no timed tasks** (no `BukkitScheduler`/`BukkitRunnable`/tick logic). + +The only things that touch score state are **five console/chat commands** +(`score-get`, `score-add`, `score-subtract`, `score-reset`, `score-archive`). +Score state lives in an **in-memory `HashMap`** and is **not +persisted** — `onEnable`/`onDisable` have `TODO` stubs, so data is lost on restart. + +There is a **`highscore` / high-score table in the project name and the task +prompt, but no such command or logic exists yet** — it is unimplemented. + +--- + +## 2. Event listeners (Bukkit/Adventure) + +**None.** The plugin listens to no server events. Confirmed by absence of any of: +`@EventHandler`, `implements Listener`, `registerEvents(`, `PlayerJoinEvent`, +`PlayerQuitEvent`, `PlayerDeathEvent`, or any other event import/registration. + +| Server event | Handler | Effect on score data | +|---|---|---| +| PlayerJoin | *none* | none | +| PlayerQuit | *none* | none | +| PlayerDeath | *none* | none | +| (all other Bukkit events) | *none* | none | +| Custom/plugin-injected events | *none* | none | + +**Implication:** nothing about a player's score changes as a result of gameplay +events (joining, quitting, dying, scoring points in-game, etc.). The only way +score data changes is through the commands in §3. + +--- + +## 3. Command registrations & permissions + +Commands are declared in `src/main/resources/plugin.yml` (no `aliases`, no +`permissions:` block, and no per-command `permission:` — so **every command is +available to every sender with no permission gating**). Each is wired to an +executor in `ScoreKeeperPlugin.onEnable()`. + +Argument-resolution idiom shared by every handler: +`boolean rcon = !(sender instanceof Player);` — an RCON caller has no self +context, so the "target = self" shortcut is unavailable and a `` +must be supplied. + +`` is resolved with `server.getPlayerExact(name)` — an **exact, +case-sensitive lookup of currently-online players only**. Score operations +therefore apply to **online players**, and an unknown/offline name yields a +"Can't find a player with that name" error (except where noted). + +### Reference table — command → handler class → effect on score data + +| Trigger (command) | Usage | Handler class | Delegates to | Effect on score data | +|---|---|---|---|---| +| `score-get` | `/score-get [player]` | `ScoreGetCommand` | `ScoreKeeperPlugin.getScore(Player)` → `getPlayerScore` | **Read only.** Returns the player's current score. Side effect: lazily registers the player at `0` if unseen. No persistent change. | +| `score-add` | `/score-add [player] ` | `ScoreAddCommand` | `ScoreKeeperPlugin.addScore(Player,int)` | `score = old + amount` (integer `amount` in `[1..]`). | +| `score-subtract` | `/score-subtract [player] ` | `ScoreSubtractCommand` | `ScoreKeeperPlugin.subtractScore(Player,int)` | `score = old - amount` (can go negative). | +| `score-reset` | `/score-reset [player]` | `ScoreResetCommand` | `ScoreKeeperPlugin.resetScore(Player)` | `score = 0` (writes 0; key created if absent). | +| `score-archive` | `/score-archive [player]` | `ScoreArchiveCommand` | *nothing* | **No state change.** Handler prints `"archive command unimplemented"`. It does **not** call `ScoreKeeperPlugin.archiveScore(...)` — see §5. | + +### Command behaviour details + +- **Sender vs. target.** Single-arg form means "operate on the invoking player" + (`split.length == 1` → `targetPlayer = sender`). Two-arg form means + ` ` (add/subtract) or `` (get/reset). For an + RCON sender, the single-arg form is treated as missing a target and prints + usage instead. +- **Amount parsing.** `score-add`/`score-subtract` require an integer + `amount`; a non-integer prints `"amount must be an integer"`. +- **Error/usage messaging.** `echoError` (red) and `echoUsage` (colour-coded) + differ between player and RCON call sites (`/score-add` vs `score-add`). + All handlers `return true` (command handled). +- **Permissions.** None declared → no operator/permission requirement; any + player or RCON can run them. + +--- + +## 4. Scheduled tasks / tick-based logic + +**None.** Confirmed by absence of `getScheduler()`, `runTask`, +`BukkitRunnable`, `BukkitTask`, `scheduleSync*`, or any periodic/repeating +logic. ScoreKeeper runs no background or tick-driven work. + +--- + +## 5. Inter-plugin dependencies & API exposure + +- **Declared dependencies:** plugin.yml has no `depend`, `softdepend`, `load`, + or `load-before` → **no declared inter-plugin coupling**. +- **Build dependency:** the only third-party dependency is + `io.papermc.paper:paper-api` (marked `compileOnly`, and explicitly ignored as a + snapshot by the release plugin). No other plugin/API is referenced. +- **Public API surface.** `ScoreKeeperPlugin` is a plain `JavaPlugin` exposing + `public` methods that other plugins *could* call if they hold a reference: + - `void addScore(Player, int)` + - `void subtractScore(Player, int)` + - `int getScore(Player)` + - `void setScore(Player, int)` — **public but used by no command** (internal + write path; the only writer not reachable via a command). + - `void resetScore(Player)` + - `void archiveScore(Player)` — **public but called by nothing**; it only logs + a warning. The `/score-archive` command does **not** invoke it. + - `void sendMessage(CommandSender, Component)`, `logInfo/logWarning/logError` +- **No formal service registration.** There is no `registerService`/`asService` + (ServiceLoader), no dedicated API artifact, and no `api:` block in plugin.yml. + Exposure is by **public method surface only** — informal and not discoverable + by other plugins. +- **Persistence (unimplemented).** `onEnable` logs a warning that load-from-file + is unimplemented; `onDisable` logs that save-to-file is unimplemented. The + `HashMap` is the sole state store and is **forgotten on restart**. + +--- + +## 6. Lifecycle + +| Hook | What it does | +|---|---| +| `onEnable()` | Wires the five `score-*` command executors; logs the "load not implemented" warning and an enable log line. | +| `onDisable()` | Logs the "save not implemented" warning. **All in-memory scores are lost on shutdown.** | + +--- + +## 7. State model (quick reference) + +- **Store:** `private HashMap _playerScores` on `ScoreKeeperPlugin` + (one map field for the whole plugin). +- **Keying:** by `Player.getUniqueId()` (UUID), so scores are per-player and + survive name changes *within a single server run*; lost on restart. +- **Lazy init:** any read (including `get`/`score-get`) auto-creates the key at `0`. +- **Writers:** `addScore`, `subtractScore`, `resetScore`, `setScore`, all funneled + through `setPlayerScore(player, value)`. +- **Concurrency:** plain `HashMap`; safe today only because command dispatch + runs on the server's main thread. Not thread-safe for off-thread use. + +--- + +## 8. "Which server trigger causes which state change" — summary + +| Trigger | State change | +|---|---| +| `/score-add [player] ` | `_playerScores[uuid] += amount` | +| `/score-subtract [player] ` | `_playerScores[uuid] -= amount` | +| `/score-reset [player]` | `_playerScores[uuid] = 0` | +| `/score-get [player]` | none (reads; lazily registers at 0) | +| `/score-archive [player]` | none (not implemented) | +| Any Minecraft/Bukkit event (join/quit/death/etc.) | **none — no listeners exist** | +| Server tick / scheduled task | **none — no scheduler exists** | +| Server enable | no data change (registration + log only) | +| Server disable | in-memory scores discarded (no persistence) | +| `addScore`/`subtractScore`/`setScore`/`archiveScore` via the public API | same table where called; only reachable by code holding a plugin reference, not by in-game events or commands (except add/subtract/reset which do have commands) |