Compare commits
6 Commits
8096aca633
...
39998917ab
| Author | SHA1 | Date | |
|---|---|---|---|
| 39998917ab | |||
| cd3c58c942 | |||
| 676407dbcb | |||
| 186afc7813 | |||
| c2abca419f | |||
| 9c69197e7f |
@@ -8,6 +8,7 @@ PAPER_USER_AGENT="majinnaibu-plugin-dev/1.0 (https://github.com/majinnaibu)"
|
||||
JAVA_OPTS="-Xms2G -Xmx2G"
|
||||
STOP_TIMEOUT=60
|
||||
MINECRAFT_SERVER_JAR=paper-26.2-129.jar
|
||||
|
||||
# Relative paths are resolved from the project root; ~/ is expanded.
|
||||
MINECRAFT_SERVER_PATH=./server
|
||||
MINECRAFT_BACKUP_PATH=./backups
|
||||
@@ -16,9 +17,10 @@ MINECRAFT_BACKUP_PATH=./backups
|
||||
# Release version is read from Gradle and checked against the jar's plugin.yml.
|
||||
MODRINTH_TOKEN=
|
||||
MODRINTH_PROJECT_ID=mob-scores
|
||||
# Optional Markdown override; empty generates notes from commits since the last tag.
|
||||
MODRINTH_CHANGELOG=
|
||||
MODRINTH_GAME_VERSIONS=1.21,1.21.1,1.21.2,1.21.3,1.21.4,1.21.5,1.21.6,1.21.7
|
||||
MODRINTH_GAME_VERSIONS=26.2,26.3
|
||||
MODRINTH_LOADERS=paper
|
||||
MODRINTH_VERSION_TYPE=
|
||||
MODRINTH_DEPENDENCIES=
|
||||
MODRINTH_DEPENDENCIES='[{"project_id":"5NYwxysp","version_id":null,"file_name":null,"dependency_type":"required"}]'
|
||||
MODRINTH_FILE=
|
||||
|
||||
46
.github/workflows/gradle.yml
vendored
46
.github/workflows/gradle.yml
vendored
@@ -1,23 +1,45 @@
|
||||
name: Gradle Build
|
||||
name: Java CI with Gradle
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "develop" ]
|
||||
pull_request:
|
||||
branches: [ "develop" ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
- name: Set up JDK 25
|
||||
uses: actions/setup-java@v6
|
||||
with:
|
||||
repository: headhunter45/ScoreKeeper
|
||||
path: ScoreKeeper
|
||||
- uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: temurin
|
||||
java-version: '25'
|
||||
- uses: gradle/actions/setup-gradle@v4
|
||||
- run: ./gradlew publishToMavenLocal
|
||||
working-directory: ScoreKeeper
|
||||
- run: ./gradlew test build
|
||||
distribution: 'temurin'
|
||||
|
||||
- name: Setup Gradle 9.8.0
|
||||
uses: gradle/actions/setup-gradle@v5
|
||||
with:
|
||||
gradle-version: '9.8.0'
|
||||
cache-read-only: ${{ github.ref != 'refs/heads/develop' }}
|
||||
|
||||
- name: Build with Gradle Wrapper
|
||||
run: ./tools/build-plugin.sh
|
||||
|
||||
- name: Extract Project Version
|
||||
id: project_info
|
||||
run: |
|
||||
VERSION=$(./gradlew properties --no-daemon -q | awk -F ': ' '$1 == "version" {print $2}')
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Upload Plugin Artifact
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: MobScores-${{ steps.project_info.outputs.version }}
|
||||
path: build/libs/*.jar
|
||||
if-no-files-found: error
|
||||
retention-days: 14
|
||||
|
||||
@@ -4,15 +4,17 @@ MobScores awards ScoreKeeper points for configured mob kills. Set a score for ea
|
||||
|
||||
## Requirements
|
||||
|
||||
- Paper 1.21.7 or a compatible newer server.
|
||||
- Paper 26.2 or 26.3.
|
||||
- Java 25 or newer at runtime and for building.
|
||||
- ScoreKeeper 0.2.2 or newer.
|
||||
|
||||
Install ScoreKeeper and MobScores in the server's `plugins` directory. ScoreKeeper is a required dependency and must be enabled for MobScores to load.
|
||||
|
||||
MobScores targets Paper only; Bukkit and Spigot servers are not supported.
|
||||
|
||||
## Configuration
|
||||
|
||||
MobScores creates `plugins/MobScores/config.yml` from its defaults. Edit `ScoreTable` to configure point values by Bukkit `EntityType` name:
|
||||
MobScores creates `plugins/MobScores/config.yml` from its defaults. Edit `ScoreTable` to configure point values by Paper API `EntityType` name:
|
||||
|
||||
```yaml
|
||||
ScoreTable:
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": "mob-scores",
|
||||
"title": "MobScores",
|
||||
"description": "Legacy Bukkit plugin that awards configurable scores for killing mobs.",
|
||||
"description": "A Paper 26.2/26.3 integration plugin that attributes mob kills, including projectile kills, and awards configurable ScoreKeeper points by entity type.",
|
||||
"docId": "MobScores",
|
||||
"image": {
|
||||
"url": "Retro Minecraft Bukkit server plugin artwork showing a blocky player defeating a hostile zombie, floating score numbers, a simple scoreboard motif, pixel-art style, dark forest-green and charcoal palette, no words or logos.",
|
||||
"url": "Retro Minecraft Paper server plugin artwork showing a blocky player defeating a hostile zombie, floating score numbers, a simple scoreboard motif, pixel-art style, dark forest-green and charcoal palette, no words or logos.",
|
||||
"alt": "Pixel-art scene of a Minecraft player defeating a zombie with score numbers floating nearby",
|
||||
"prompt": "Retro Minecraft Bukkit server plugin artwork showing a blocky player defeating a hostile zombie, floating score numbers, a simple scoreboard motif, pixel-art style, dark forest-green and charcoal palette, no words or logos.",
|
||||
"prompt": "Retro Minecraft Paper server plugin artwork showing a blocky player defeating a hostile zombie, floating score numbers, a simple scoreboard motif, pixel-art style, dark forest-green and charcoal palette, no words or logos.",
|
||||
"width": 0,
|
||||
"height": 0,
|
||||
"backgroundClassName": "bg-surface"
|
||||
|
||||
@@ -1,16 +1,12 @@
|
||||
# MobScores
|
||||
|
||||
MobScores is a legacy Bukkit plugin that awards configurable scores to players for killing mobs. It works with the `ScoreKeeper` plugin, records the player who last damaged a mob, and awards the configured value when that mob dies.
|
||||
MobScores turns combat into a configurable scoring system. When a player damages a tracked mob, the plugin remembers the attribution and awards the matching ScoreKeeper bucket when that mob dies, including projectile kills.
|
||||
|
||||
## Details
|
||||
It is a deliberately small Paper integration plugin with a clear boundary: Paper entity events on one side, ScoreKeeper's public scoring API on the other. The per-entity score table is configurable, zero-value entries can be disabled, and players see the active mob-score table when they join. It targets Paper 26.2 and 26.3 only, not Bukkit or Spigot.
|
||||
|
||||
- Platform: Bukkit/Minecraft server plugin
|
||||
- Language: Java
|
||||
- Dependency: ScoreKeeper
|
||||
- Configuration: `plugins/MobScores/config.yml`
|
||||
- Commands: None
|
||||
- License: GNU Affero General Public License v3
|
||||
## Engineering Notes
|
||||
|
||||
## Image prompt
|
||||
|
||||
Retro Minecraft Bukkit server plugin artwork showing a blocky player defeating a hostile zombie, floating score numbers, a simple scoreboard motif, pixel-art style, dark forest-green and charcoal palette, no words or logos.
|
||||
- Built for modern Paper with Java 25 and Gradle.
|
||||
- Uses UUID-safe player attribution.
|
||||
- Depends on ScoreKeeper 0.2.2 or newer.
|
||||
- Tested through the standard server-free build workflow.
|
||||
|
||||
10
README.md
10
README.md
@@ -1,18 +1,18 @@
|
||||
# MobScores
|
||||
|
||||
MobScores awards ScoreKeeper points for configured mob kills. It is a Paper plugin and requires the ScoreKeeper plugin to be installed and enabled first.
|
||||
MobScores awards ScoreKeeper points for configured mob kills. It is a Paper-only plugin for Paper 26.2 and 26.3, and requires the ScoreKeeper plugin to be installed and enabled first.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Paper 1.21.7 or a compatible newer server.
|
||||
- Paper 26.2 or 26.3.
|
||||
- Java 25 to build the plugin.
|
||||
- ScoreKeeper 0.2.2 or newer.
|
||||
|
||||
Install both plugin JARs in the server's `plugins` directory. MobScores declares ScoreKeeper as a hard dependency, so it will not enable without it.
|
||||
Install both plugin JARs in the server's `plugins` directory. MobScores declares ScoreKeeper as a hard dependency, so it will not enable without it. Bukkit and Spigot servers are not supported.
|
||||
|
||||
## Score Table
|
||||
|
||||
On first startup, MobScores creates `plugins/MobScores/config.yml` with default scores for supported entity types. Edit the `ScoreTable` mapping to change points; keys are Bukkit `EntityType` names and values are integer points:
|
||||
On first startup, MobScores creates `plugins/MobScores/config.yml` with default scores for supported entity types. Edit the `ScoreTable` mapping to change points; keys are Paper API `EntityType` names and values are integer points:
|
||||
|
||||
```yaml
|
||||
ScoreTable:
|
||||
@@ -21,7 +21,7 @@ ScoreTable:
|
||||
SILVERFISH: 0
|
||||
```
|
||||
|
||||
Restart the server after editing the configuration. A configured value of `0` suppresses that entity from the score table shown to players when they join.
|
||||
Restart the server after editing the configuration. A configured value of `0` suppresses that entity from the score table shown to players when they join. Entity type keys use the Paper API's `EntityType` names.
|
||||
|
||||
MobScores has no commands of its own. It records credit for configured entity types damaged directly by a player or by a projectile fired by a player. Other mob attribution is not currently handled. Points go into ScoreKeeper's dedicated `mob-scores` bucket and are tracked by player UUID. Use `/score-bucket mob-scores` before `/score-get` to view mob points; MobScores does not change the player's active bucket automatically.
|
||||
|
||||
|
||||
6
TODO.md
6
TODO.md
@@ -24,6 +24,6 @@
|
||||
| MS-20 | Done | Update event registration in MobScoresPlugin to use getServer().getPluginManager().registerEvents(...).
|
||||
| MS-21 | Done | Replace all usage of org.bukkit.util.config.Configuration with the modern Bukkit configuration API (getConfig(), saveConfig(), reloadConfig(), etc.).
|
||||
| MS-22 | Done | Remove or refactor any code using deprecated or removed Bukkit/Spigot/Paper APIs that are not available in the modern Paper API.
|
||||
| MS-23 | Ready | Add JUnit 5 test infrastructure and keep the default Gradle `test` task server-free. Use an in-memory Paper test harness such as MockBukkit for plugin lifecycle and Bukkit/Paper behavior; use Mockito or test doubles for ScoreKeeper and narrow API boundaries where a harness is unnecessary. |
|
||||
| MS-24 | Ready | Add fast unit tests for MobScores behavior: default and configured score-table loading, serialization and malformed or unknown entity entries; direct-player and projectile damage attribution; ignoring untracked entities and non-player damage; death awards, offline credited players, zero-value scores, and join-time score messages. |
|
||||
| MS-25 | Ready | Add a separate Gradle `integrationTest` source set/task for behavior requiring a real Paper server with the built MobScores and ScoreKeeper jars installed. Verify plugin loading and ScoreKeeper compatibility, mob-death score awards and player-facing messages, and score-table persistence across a server restart. Run it only when explicitly requested; keep it out of the normal `test` and `build` tasks. |
|
||||
| MS-23 | Ready | Add JUnit 5 test infrastructure and keep the default Gradle `test` task server-free. Use an in-memory Paper test harness such as MockBukkit for plugin lifecycle and Bukkit/Paper behavior; use Mockito or test doubles for ScoreKeeper and narrow API boundaries where a harness is unnecessary. |
|
||||
| MS-24 | Ready | Add fast unit tests for MobScores behavior: default and configured score-table loading, serialization and malformed or unknown entity entries; direct-player and projectile damage attribution; ignoring untracked entities and non-player damage; death awards, offline credited players, zero-value scores, and join-time score messages. |
|
||||
| MS-25 | Ready | Add a separate Gradle `integrationTest` source set/task for behavior requiring a real Paper server with the built MobScores and ScoreKeeper jars installed. Verify plugin loading and ScoreKeeper compatibility, mob-death score awards and player-facing messages, and score-table persistence across a server restart. Run it only when explicitly requested; keep it out of the normal `test` and `build` tasks. |
|
||||
|
||||
20
build.gradle
20
build.gradle
@@ -18,17 +18,31 @@ gitSemVer {
|
||||
repositories {
|
||||
mavenCentral()
|
||||
maven { url = 'https://repo.papermc.io/repository/maven-public/' }
|
||||
|
||||
// Modrinth Maven repository for ScoreKeeper
|
||||
exclusiveContent {
|
||||
forRepository {
|
||||
maven {
|
||||
name = 'Modrinth'
|
||||
url = 'https://api.modrinth.com/maven'
|
||||
}
|
||||
}
|
||||
filter {
|
||||
includeGroup 'maven.modrinth'
|
||||
}
|
||||
}
|
||||
|
||||
mavenLocal()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly 'com.majinnaibu.minecraft.plugins:ScoreKeeper:0.2.2'
|
||||
compileOnly 'io.papermc.paper:paper-api:1.21.7-R0.1-SNAPSHOT'
|
||||
// Group is always 'maven.modrinth', module is your project slug/id
|
||||
compileOnly 'maven.modrinth:scorekeeper:0.2.2'
|
||||
compileOnly 'io.papermc.paper:paper-api:26.2.build.129-stable'
|
||||
|
||||
testImplementation libs.junit.junit
|
||||
}
|
||||
|
||||
|
||||
group = 'com.majinnaibu.minecraft.plugins'
|
||||
description = 'MobScores'
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
org.gradle.configuration-cache=true
|
||||
org.gradle.daemon=true
|
||||
org.gradle.java.installations.auto-download=true
|
||||
org.gradle.java.installations.auto-detect=false
|
||||
org.gradle.java.installations.fromEnv=JAVA_HOME
|
||||
org.gradle.configuration-cache=true
|
||||
org.gradle.daemon=true
|
||||
|
||||
@@ -19,6 +19,7 @@ package com.majinnaibu.minecraft.plugins.mobscores;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import java.util.UUID;
|
||||
import java.util.logging.Level;
|
||||
|
||||
@@ -155,9 +156,9 @@ public class MobScoresPlugin extends JavaPlugin {
|
||||
for (Map.Entry<EntityType, Integer> entry : _scoreTable.entrySet()) {
|
||||
if (entry.getValue() != 0) {
|
||||
EntityType type = entry.getKey();
|
||||
Component message = Component.translatable(type.translationKey())
|
||||
Component message = Component.translatable(Objects.requireNonNull(type.translationKey()))
|
||||
.append(Component.text(" = "))
|
||||
.append(Component.text(String.valueOf(entry.getValue()))
|
||||
.append(Component.text(Objects.requireNonNull(String.valueOf(entry.getValue())))
|
||||
.color(NamedTextColor.GREEN));
|
||||
sendPlayerMessage(player, message);
|
||||
}
|
||||
@@ -192,11 +193,11 @@ public class MobScoresPlugin extends JavaPlugin {
|
||||
}
|
||||
|
||||
public void sendPlayerMessage(Player player, Component message) {
|
||||
player.sendMessage(_messagePrefix.append(message));
|
||||
player.sendMessage(_messagePrefix.append(Objects.requireNonNull(message)));
|
||||
}
|
||||
|
||||
public void sendPlayerMessage(Player player, String message) {
|
||||
player.sendMessage(_messagePrefix.append(Component.text(message)));
|
||||
player.sendMessage(_messagePrefix.append(Component.text(Objects.requireNonNull(message))));
|
||||
}
|
||||
|
||||
public void logError(Exception ex) {
|
||||
|
||||
@@ -2,4 +2,4 @@ name: MobScores
|
||||
main: com.majinnaibu.minecraft.plugins.mobscores.MobScoresPlugin
|
||||
depend: [ScoreKeeper]
|
||||
version: ${version}
|
||||
api-version: 1.21
|
||||
api-version: '26.2'
|
||||
|
||||
@@ -40,8 +40,24 @@ load_project_env
|
||||
|
||||
MODRINTH_TOKEN="${MODRINTH_TOKEN:-}"
|
||||
MODRINTH_PROJECT_ID="${MODRINTH_PROJECT_ID:-mob-scores}"
|
||||
MODRINTH_CHANGELOG="${MODRINTH_CHANGELOG:-Auto release via publish-modrinth.sh}"
|
||||
MODRINTH_GAME_VERSIONS="${MODRINTH_GAME_VERSIONS:-1.21,1.21.1,1.21.2,1.21.3,1.21.4,1.21.5,1.21.6,1.21.7}"
|
||||
generate_changelog() {
|
||||
local current_tag previous_tag range commits
|
||||
current_tag=$(git -C "$PROJECT_ROOT" describe --tags --exact-match HEAD 2>/dev/null || true)
|
||||
if [[ -n "$current_tag" ]]; then
|
||||
previous_tag=$(git -C "$PROJECT_ROOT" describe --tags --abbrev=0 "${current_tag}^" 2>/dev/null || true)
|
||||
range="${previous_tag:+$previous_tag..}$current_tag"
|
||||
else
|
||||
previous_tag=$(git -C "$PROJECT_ROOT" describe --tags --abbrev=0 2>/dev/null || true)
|
||||
range="${previous_tag:+$previous_tag..}HEAD"
|
||||
fi
|
||||
commits=$(git -C "$PROJECT_ROOT" log --no-merges --format='- %s (%h)' "$range" 2>/dev/null || true)
|
||||
if [[ -z "$commits" ]]; then
|
||||
commits='- No commit messages found for this release.'
|
||||
fi
|
||||
printf '%s\n\n%s\n' "## What's Changed" "$commits"
|
||||
}
|
||||
MODRINTH_CHANGELOG="${MODRINTH_CHANGELOG:-$(generate_changelog)}"
|
||||
MODRINTH_GAME_VERSIONS="${MODRINTH_GAME_VERSIONS:-26.2,26.3}"
|
||||
MODRINTH_LOADERS="${MODRINTH_LOADERS:-paper}"
|
||||
MODRINTH_VERSION_TYPE="${MODRINTH_VERSION_TYPE:-}"
|
||||
MODRINTH_FILE="${MODRINTH_FILE:-}"
|
||||
|
||||
Reference in New Issue
Block a user