Updates spotless and adds a license header.

This commit is contained in:
2026-09-27 02:29:43 -07:00
parent 39998917ab
commit db43411628
6 changed files with 427 additions and 371 deletions

41
Human-Tests.md Normal file
View File

@@ -0,0 +1,41 @@
# MobScores Human Testing
Use this checklist on a disposable Paper 26.2 or 26.3 server with Java 25+, MobScores, and ScoreKeeper 0.2.2 or newer installed. MobScores depends on ScoreKeeper for its `mob-scores` bucket, and its main behavior is driven by real combat and player-join events.
## Test Setup
- Back up the world and both plugin data folders. Configure a test server with the same plugin versions intended for production.
- Use at least two ordinary player accounts and an operator for setup. Keep the server log visible to catch dependency, config, and offline-award warnings.
- Save the generated `plugins/MobScores/config.yml` before changing it. Restart after config edits; MobScores reads the score table during plugin startup.
- Record player UUIDs, mob types, configured values, active score buckets, and scores before and after each kill.
## Human Checklist
### Plugin loading and configuration
- Start with both plugins installed. Confirm ScoreKeeper loads before MobScores, MobScores enables, and the `mob-scores` bucket exists with the expected labels and initial value.
- On a disposable server, test startup without ScoreKeeper and with a ScoreKeeper version older than 0.2.2. Paper should reject the missing hard dependency; MobScores should disable itself with a version warning for an outdated dependency. Then restore the supported version.
- On first startup, inspect the generated `ScoreTable`. Confirm the documented default entity values are present, including a zero-valued entry.
- Change a few values, restart, and verify they are loaded and preserved. Include a zero value and an unknown entity key; confirm zero-valued entities are omitted from join messages and invalid entries are logged without preventing valid entries from loading.
- Confirm the table uses Paper `EntityType` names and that malformed values or a missing score-table section are handled as intended.
### Kill credit and scoring
- As a player, kill configured entities using direct melee damage and player-fired projectiles. Confirm the expected points are added to that player's `mob-scores` score.
- Check the boundary cases: a non-player attacker, environmental death, an entity type absent from the table, and a configured zero-point entity. Confirm no unintended points are awarded.
- Have two players damage the same mob before it dies. The current implementation records the most recent direct or player-projectile attacker; verify that this credit policy matches the server's expectations.
- Damage a mob with a player, then let it die from fall, fire, or another environmental cause. Confirm whether retaining that player's credit is the intended behavior; the current implementation keeps the last recorded player attribution until the mob dies.
- Test a player who disconnects after damaging the mob but before it dies. The current implementation cannot award an offline player and logs a warning; confirm this is acceptable and that no other player's score changes.
- Check mob death without any previous qualifying player damage, and verify no stale or reused entity attribution grants points.
### Player messaging and ScoreKeeper workflows
- Join with a player account. Confirm the MobScores score table is sent once, includes configured nonzero entity types with the right values, and excludes zero-valued types.
- Run `/score-bucket mob-scores` followed by `/score-get`. Confirm the score reflects kills and the bucket switch message uses the expected singular/plural label. Verify MobScores does not change the player's active bucket automatically on join or kill.
- Give two players different kill totals and switch between `mob-scores` and another ScoreKeeper bucket. Confirm each bucket retains its own value and MobScores awards only to `mob-scores`.
- Restart the server and verify MobScores retains its configured table and ScoreKeeper retains the players' mob scores. Reconnect and confirm the join table still matches the active config.
- Exercise normal gameplay around claimed mobs: unload/reload chunks, kill several entities rapidly, and test multiplayer combat. Watch for missed, duplicated, or cross-player awards.
## Automated Coverage
There are currently no Java test sources in MobScores and no `integrationTest` source set/task. Although Gradle declares JUnit, `./gradlew test` currently has no MobScores behavior tests. The testing tasks marked “Ready” in `TODO.md` have not been implemented. Build success alone does not verify real event attribution or compatibility with the installed ScoreKeeper jar.

View File

@@ -5,6 +5,7 @@
*/
plugins {
id 'com.diffplug.spotless' version '8.10.3'
id 'java-library'
id 'maven-publish'
id 'org.danilopianini.git-sensitive-semantic-versioning' version '7.0.24'
@@ -91,3 +92,14 @@ processResources {
expand(version: pluginVersion)
}
}
spotless {
java {
googleJavaFormat('1.36.1')
importOrder 'java', 'javax', 'com', 'net', 'org', ''
licenseHeaderFile 'config/license-header.txt'
target 'src/**/*.java'
removeUnusedImports()
toggleOffOn()
}
}

View File

@@ -1,17 +1,17 @@
/*
This file is part of MobScores.
This file is part of Mob Scores.
MobScores is free software: you can redistribute it and/or modify
Mob Scores is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MobScores is distributed in the hope that it will be useful,
Mob Scores is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with MobScores. If not, see <http://www.gnu.org/licenses/>.
along with Mob Scores. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
*/

View File

@@ -1,18 +1,18 @@
/*
This file is part of MobScores.
This file is part of Mob Scores.
MobScores is free software: you can redistribute it and/or modify
Mob Scores is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MobScores is distributed in the hope that it will be useful,
Mob Scores is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with MobScores. If not, see <http://www.gnu.org/licenses/>.
along with Mob Scores. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
*/
package com.majinnaibu.minecraft.plugins.mobscores;
@@ -23,6 +23,10 @@ import java.util.Objects;
import java.util.UUID;
import java.util.logging.Level;
import com.majinnaibu.minecraft.plugins.mobscores.listeners.MobDeathListener;
import com.majinnaibu.minecraft.plugins.mobscores.listeners.PlayerConnectListener;
import com.majinnaibu.minecraft.plugins.scorekeeper.ScoreKeeperPlugin;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.format.NamedTextColor;
@@ -32,10 +36,6 @@ import org.bukkit.entity.Player;
import org.bukkit.plugin.PluginManager;
import org.bukkit.plugin.java.JavaPlugin;
import com.majinnaibu.minecraft.plugins.mobscores.listeners.MobDeathListener;
import com.majinnaibu.minecraft.plugins.mobscores.listeners.PlayerConnectListener;
import com.majinnaibu.minecraft.plugins.scorekeeper.ScoreKeeperPlugin;
public class MobScoresPlugin extends JavaPlugin {
private static final String SCORE_BUCKET_ID = "mob-scores";
private static final String MIN_SCORE_KEEPER_VERSION = "0.2.2";
@@ -45,7 +45,8 @@ public class MobScoresPlugin extends JavaPlugin {
private ScoreKeeperPlugin _scoreKeeper = null;
private final String _logPrefix = "[MobScores] ";
private final Component _messagePrefix = Component.text("[")
private final Component _messagePrefix =
Component.text("[")
.append(Component.text("MobScores").color(NamedTextColor.AQUA))
.append(Component.text("] ").color(NamedTextColor.WHITE));
@@ -62,7 +63,8 @@ public class MobScoresPlugin extends JavaPlugin {
// Load our score table from config or set defaults.
if (getConfig().isConfigurationSection("ScoreTable")) {
_scoreTable = deserializeScoreTable(getConfig().getConfigurationSection("ScoreTable").getValues(false));
_scoreTable =
deserializeScoreTable(getConfig().getConfigurationSection("ScoreTable").getValues(false));
} else {
_scoreTable = getDefaultScoreTable();
getConfig().set("ScoreTable", serializeScoreTable(_scoreTable));
@@ -70,7 +72,7 @@ public class MobScoresPlugin extends JavaPlugin {
}
PluginManager pm = getServer().getPluginManager();
ScoreKeeperPlugin scoreKeeper = (ScoreKeeperPlugin)pm.getPlugin("ScoreKeeper");
ScoreKeeperPlugin scoreKeeper = (ScoreKeeperPlugin) pm.getPlugin("ScoreKeeper");
if (scoreKeeper == null) {
logWarning("Unable to find ScoreKeeper plugin.");
@@ -97,7 +99,8 @@ public class MobScoresPlugin extends JavaPlugin {
pm.registerEvents(new MobDeathListener(this), this);
pm.registerEvents(new PlayerConnectListener(this), this);
logInfo(getPluginMeta().getName() + " version " + getPluginMeta().getVersion() + " is enabled!");
logInfo(
getPluginMeta().getName() + " version " + getPluginMeta().getVersion() + " is enabled!");
}
private HashMap<EntityType, Integer> getDefaultScoreTable() {
@@ -136,7 +139,7 @@ public class MobScoresPlugin extends JavaPlugin {
public void awardScore(Entity entity) {
UUID playerId = _claimedMobs.remove(entity.getUniqueId());
if(playerId != null){
if (playerId != null) {
EntityType type = entity.getType();
if (_scoreTable.containsKey(type)) {
Player player = getServer().getPlayer(playerId);
@@ -156,9 +159,11 @@ 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(Objects.requireNonNull(type.translationKey()))
Component message =
Component.translatable(Objects.requireNonNull(type.translationKey()))
.append(Component.text(" = "))
.append(Component.text(Objects.requireNonNull(String.valueOf(entry.getValue())))
.append(
Component.text(Objects.requireNonNull(String.valueOf(entry.getValue())))
.color(NamedTextColor.GREEN));
sendPlayerMessage(player, message);
}

View File

@@ -1,33 +1,33 @@
/*
This file is part of MobScores.
This file is part of Mob Scores.
MobScores is free software: you can redistribute it and/or modify
Mob Scores is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MobScores is distributed in the hope that it will be useful,
Mob Scores is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with MobScores. If not, see <http://www.gnu.org/licenses/>.
along with Mob Scores. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
*/
package com.majinnaibu.minecraft.plugins.mobscores.listeners;
import com.majinnaibu.minecraft.plugins.mobscores.MobScoresPlugin;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Player;
import org.bukkit.entity.Projectile;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.entity.EntityDamageByEntityEvent;
import org.bukkit.event.entity.EntityDamageEvent;
import org.bukkit.event.entity.EntityDeathEvent;
import org.bukkit.event.entity.EntityExplodeEvent;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import com.majinnaibu.minecraft.plugins.mobscores.MobScoresPlugin;
public class MobDeathListener implements Listener {
private MobScoresPlugin _plugin = null;
@@ -60,7 +60,5 @@ public class MobDeathListener implements Listener {
}
@EventHandler
public void onEntityExplode(EntityExplodeEvent event) {
}
public void onEntityExplode(EntityExplodeEvent event) {}
}

View File

@@ -1,30 +1,30 @@
/*
This file is part of MobScores.
This file is part of Mob Scores.
MobScores is free software: you can redistribute it and/or modify
Mob Scores is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MobScores is distributed in the hope that it will be useful,
Mob Scores is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with MobScores. If not, see <http://www.gnu.org/licenses/>.
along with Mob Scores. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
*/
package com.majinnaibu.minecraft.plugins.mobscores.listeners;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.event.Listener;
import org.bukkit.event.EventHandler;
import com.majinnaibu.minecraft.plugins.mobscores.MobScoresPlugin;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
public class PlayerConnectListener implements Listener {
private MobScoresPlugin _plugin = null;
private MobScoresPlugin _plugin = null;
public PlayerConnectListener(MobScoresPlugin plugin) {
_plugin = plugin;