Compare commits

...
2 Commits
Author SHA1 Message Date
dmg 63dc5ff736 feat(classes): add tyrant class assignment
Release / release (push) Successful in 2m14s
CI / build (push) Successful in 57s
2026-08-14 22:37:09 -04:00
dmg 805efda8bb feat(progression): add tyrant unlock choices
Release / release (push) Successful in 2m9s
CI / build (push) Successful in 55s
2026-08-14 22:33:11 -04:00
22 changed files with 926 additions and 18 deletions
+21
View File
@@ -6,6 +6,27 @@ description: Chronological record of material decisions affecting the Spigot Tyr
# Spigot Tyrant Design Log
## 2026-08-14 — Tyrant class assignment completed
- Completed US-004 with `/tyrant assign <class> <player>`, purchased-class authorization, UUID state, one holder per class, and one Tyrant-side class per player.
- Preserved dual alignment so Vigilantes and Followers can hold a Tyrant-side class, while rejecting the Tyrant and opted-out targets.
- Added reassignment and reign cleanup for class cooldown/item state, online assignment/removal notices, and login control reminders.
- Verified assignment constraints, dual alignment, cleanup, commands, notifications, and reminders with the Gradle test suite.
## 2026-08-14 — Tyrant class assignment implementation started
- US-004 begins with test-first purchased-class authorization, one-holder constraints, dual alignment, reassignment cleanup, and reign-wide removal.
## 2026-08-14 — Tyrant progression completed
- Completed US-003 with exact Tyrant-on-Vigilante kill attribution, level and choice rewards, pause guards, one-time purchases, and reign reset behavior.
- Added `/tyrant choices` status output and `/tyrant buy <unlock>` with durable atomic state updates and clear failure feedback.
- Verified progression, duplicate purchase, authorization, paused-state, reset, command presentation, metadata, and persistence behavior with the Gradle test suite.
## 2026-08-14 — Tyrant progression implementation started
- US-003 begins with test-first kill attribution, one-time unlock purchases, and player-visible choice status.
## 2026-08-14 — Configuration and persistence completed
- Completed US-012 with validated defaults for ranges, timers, effects, items, messages, and mob restrictions, including runtime Bukkit section parsing.
@@ -2,7 +2,7 @@
type: User Story
title: "US-003: Progress and purchase Tyrant unlocks"
description: Let the Tyrant earn and spend choices by personally defeating the Vigilante.
status: backlog
status: done
---
# US-003: Progress and purchase Tyrant unlocks
@@ -11,14 +11,14 @@ As the **Tyrant**, I want to earn one meaningful choice for defeating the Vigila
## Acceptance criteria
- [ ] The Tyrant gains one level and one unlock choice only when personally credited with killing the current Vigilante.
- [ ] A Vigilante death caused by another player, the environment, or the Vigilante does not level the Tyrant.
- [ ] Available purchases are Assassin, Fixer, Tamer, roster intelligence, permanent Resistance, and permanent Strength.
- [ ] Each class or ability can be purchased at most once during a reign.
- [ ] A menu or command clearly identifies purchased, available, and unavailable choices.
- [ ] A purchase consumes exactly one unspent choice and cannot be duplicated by retries or concurrent input.
- [ ] Progress cannot be earned or spent while the game is paused.
- [ ] Levels, purchases, and unspent choices survive logout and restart but reset when the reign ends.
- [x] The Tyrant gains one level and one unlock choice only when personally credited with killing the current Vigilante.
- [x] A Vigilante death caused by another player, the environment, or the Vigilante does not level the Tyrant.
- [x] Available purchases are Assassin, Fixer, Tamer, roster intelligence, permanent Resistance, and permanent Strength.
- [x] Each class or ability can be purchased at most once during a reign.
- [x] A menu or command clearly identifies purchased, available, and unavailable choices.
- [x] A purchase consumes exactly one unspent choice and cannot be duplicated by retries or concurrent input.
- [x] Progress cannot be earned or spent while the game is paused.
- [x] Levels, purchases, and unspent choices survive logout and restart but reset when the reign ends.
## Related
@@ -2,7 +2,7 @@
type: User Story
title: "US-004: Assign unlocked classes"
description: Let the Tyrant assign each purchased class to one eligible participant.
status: backlog
status: done
---
# US-004: Assign unlocked classes
@@ -11,14 +11,14 @@ As the **Tyrant**, I want to assign unlocked specialist classes so that I can bu
## Acceptance criteria
- [ ] The Tyrant can assign only Assassin, Fixer, and Tamer classes purchased during the current reign.
- [ ] Each class can be assigned to at most one player at a time, and a player can hold at most one Tyrant-side class.
- [ ] Role alignment and Tyrant-side class are independent: the Vigilante or a Follower may simultaneously be the Assassin, Fixer, or Tamer.
- [ ] The Tyrant cannot assign a class to the Tyrant, an opted-out player, or another ineligible player.
- [ ] Reassignment removes the class and its bound items and effects from the previous holder before granting it to the new holder.
- [ ] Assignment and removal are stored by UUID and communicated clearly to affected players.
- [ ] A class holder is reminded of the assignment and its controls on login.
- [ ] All class assignments end when the Tyrant's reign ends.
- [x] The Tyrant can assign only Assassin, Fixer, and Tamer classes purchased during the current reign.
- [x] Each class can be assigned to at most one player at a time, and a player can hold at most one Tyrant-side class.
- [x] Role alignment and Tyrant-side class are independent: the Vigilante or a Follower may simultaneously be the Assassin, Fixer, or Tamer.
- [x] The Tyrant cannot assign a class to the Tyrant, an opted-out player, or another ineligible player.
- [x] Reassignment removes the class and its bound items and effects from the previous holder before granting it to the new holder.
- [x] Assignment and removal are stored by UUID and communicated clearly to affected players.
- [x] A class holder is reminded of the assignment and its controls on login.
- [x] All class assignments end when the Tyrant's reign ends.
## Related
@@ -0,0 +1,17 @@
package games.dmg.spigottyrant;
import java.util.UUID;
import org.bukkit.Bukkit;
import org.bukkit.entity.Player;
public final class BukkitOnlinePlayerDirectory implements OnlinePlayerDirectory {
@Override
public Player findByName(String name) {
return Bukkit.getPlayerExact(name);
}
@Override
public Player findById(UUID playerId) {
return Bukkit.getPlayer(playerId);
}
}
@@ -0,0 +1,18 @@
package games.dmg.spigottyrant;
public final class ClassAssignmentMessages {
private ClassAssignmentMessages() {
}
public static String loginReminder(PlayerState player) {
return switch (player.tyrantClass()) {
case ASSASSIN -> "Class: ASSASSIN. Use your Assassin Cloak; double-jump while "
+ "airborne. Use /tyrant item to recover ready class items.";
case FIXER -> "Class: FIXER. Use your Fixer's Wrench to activate your boost. "
+ "Use /tyrant item to recover ready class items.";
case TAMER -> "Class: TAMER. Use your Tamer's Lead to capture mobs. "
+ "Use /tyrant item to recover ready class items.";
case NONE -> "";
};
}
}
@@ -0,0 +1,16 @@
package games.dmg.spigottyrant;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
public record ClassAssignmentResult(
Map<UUID, PlayerState> players,
ClassAssignmentStatus status,
Optional<UUID> previousHolderId
) {
public ClassAssignmentResult {
players = Map.copyOf(players);
previousHolderId = previousHolderId == null ? Optional.empty() : previousHolderId;
}
}
@@ -0,0 +1,129 @@
package games.dmg.spigottyrant;
import java.time.Instant;
import java.util.EnumMap;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
public final class ClassAssignmentService {
public ClassAssignmentResult assign(
GameState game,
Map<UUID, PlayerState> players,
UUID assignerId,
UUID targetId,
TyrantClass tyrantClass,
Instant now
) {
ClassAssignmentStatus rejected = rejection(
game, players, assignerId, targetId, tyrantClass, now
);
if (rejected != null) {
return new ClassAssignmentResult(players, rejected, Optional.empty());
}
Map<UUID, PlayerState> updated = new HashMap<>(players);
Optional<UUID> previousHolder = players.values().stream()
.filter(player -> player.tyrantClass() == tyrantClass)
.map(PlayerState::playerId)
.filter(playerId -> !playerId.equals(targetId))
.findFirst();
previousHolder.ifPresent(playerId -> updated.put(
playerId,
withClass(updated.get(playerId), TyrantClass.NONE)
));
updated.put(targetId, withClass(updated.get(targetId), tyrantClass));
return new ClassAssignmentResult(
updated,
ClassAssignmentStatus.ASSIGNED,
previousHolder
);
}
public Map<UUID, PlayerState> clearAll(Map<UUID, PlayerState> players) {
Map<UUID, PlayerState> updated = new HashMap<>();
for (PlayerState player : players.values()) {
updated.put(player.playerId(), withClass(player, TyrantClass.NONE));
}
return Map.copyOf(updated);
}
private static ClassAssignmentStatus rejection(
GameState game,
Map<UUID, PlayerState> players,
UUID assignerId,
UUID targetId,
TyrantClass tyrantClass,
Instant now
) {
if (game.lifecycle() != GameLifecycle.RUNNING) {
return ClassAssignmentStatus.GAME_NOT_RUNNING;
}
if (game.tyrantId().isEmpty() || !game.tyrantId().orElseThrow().equals(assignerId)) {
return ClassAssignmentStatus.NOT_TYRANT;
}
if (tyrantClass == null || tyrantClass == TyrantClass.NONE) {
return ClassAssignmentStatus.INVALID_CLASS;
}
if (!game.purchases().contains(unlockFor(tyrantClass))) {
return ClassAssignmentStatus.CLASS_NOT_UNLOCKED;
}
PlayerState target = players.get(targetId);
if (target == null) {
return ClassAssignmentStatus.UNKNOWN_PLAYER;
}
if (targetId.equals(assignerId)) {
return ClassAssignmentStatus.TARGET_IS_TYRANT;
}
if (target.optedOutUntil().filter(until -> until.isAfter(now)).isPresent()) {
return ClassAssignmentStatus.TARGET_OPTED_OUT;
}
return null;
}
private static TyrantUnlock unlockFor(TyrantClass tyrantClass) {
return switch (tyrantClass) {
case ASSASSIN -> TyrantUnlock.ASSASSIN;
case FIXER -> TyrantUnlock.FIXER;
case TAMER -> TyrantUnlock.TAMER;
case NONE -> throw new IllegalArgumentException("NONE is not assignable");
};
}
private static PlayerState withClass(PlayerState player, TyrantClass tyrantClass) {
Map<Ability, Instant> cooldowns = new EnumMap<>(Ability.class);
cooldowns.putAll(player.cooldownEnds());
Set<Ability> readyItems = EnumSet.noneOf(Ability.class);
readyItems.addAll(player.readyAbilityItems());
for (Ability ability : abilitiesFor(player.tyrantClass())) {
cooldowns.remove(ability);
readyItems.remove(ability);
}
return new PlayerState(
player.playerId(),
player.latestName(),
player.lastLogin(),
player.optedOutUntil(),
tyrantClass,
player.followerOf(),
cooldowns,
readyItems,
player.capturedMobs()
);
}
private static Set<Ability> abilitiesFor(TyrantClass tyrantClass) {
return switch (tyrantClass) {
case ASSASSIN -> Set.of(
Ability.ASSASSIN_INVISIBILITY,
Ability.ASSASSIN_DOUBLE_JUMP
);
case FIXER -> Set.of(Ability.FIXER_BOOST);
case TAMER -> Set.of(Ability.TAMER_CAPTURE);
case NONE -> Set.of();
};
}
}
@@ -0,0 +1,12 @@
package games.dmg.spigottyrant;
public enum ClassAssignmentStatus {
ASSIGNED,
GAME_NOT_RUNNING,
NOT_TYRANT,
CLASS_NOT_UNLOCKED,
INVALID_CLASS,
UNKNOWN_PLAYER,
TARGET_IS_TYRANT,
TARGET_OPTED_OUT
}
@@ -0,0 +1,10 @@
package games.dmg.spigottyrant;
import java.util.UUID;
import org.bukkit.entity.Player;
public interface OnlinePlayerDirectory {
Player findByName(String name);
Player findById(UUID playerId);
}
@@ -0,0 +1,33 @@
package games.dmg.spigottyrant;
import java.time.Clock;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
public final class PlayerJoinListener implements Listener {
private final TyrantStateManager stateManager;
private final Clock clock;
public PlayerJoinListener(TyrantStateManager stateManager, Clock clock) {
this.stateManager = stateManager;
this.clock = clock;
}
@EventHandler
public void onJoin(PlayerJoinEvent event) {
PlayerState player = stateManager.updatePlayer(
event.getPlayer().getUniqueId(),
event.getPlayer().getName(),
current -> new PlayerState(
current.playerId(), current.latestName(), java.util.Optional.of(clock.instant()),
current.optedOutUntil(), current.tyrantClass(), current.followerOf(),
current.cooldownEnds(), current.readyAbilityItems(), current.capturedMobs()
)
);
String reminder = ClassAssignmentMessages.loginReminder(player);
if (!reminder.isEmpty()) {
event.getPlayer().sendMessage(reminder);
}
}
}
@@ -0,0 +1,10 @@
package games.dmg.spigottyrant;
import java.util.Objects;
public record PurchaseResult(GameState state, PurchaseStatus status) {
public PurchaseResult {
Objects.requireNonNull(state, "state");
Objects.requireNonNull(status, "status");
}
}
@@ -0,0 +1,9 @@
package games.dmg.spigottyrant;
public enum PurchaseStatus {
PURCHASED,
GAME_NOT_RUNNING,
NOT_TYRANT,
NO_CHOICES,
ALREADY_PURCHASED
}
@@ -1,7 +1,9 @@
package games.dmg.spigottyrant;
import java.io.IOException;
import java.time.Clock;
import java.util.Map;
import java.util.Objects;
import java.util.logging.Level;
import org.bukkit.plugin.java.JavaPlugin;
@@ -25,6 +27,12 @@ public final class SpigotTyrantPlugin extends JavaPlugin {
return;
}
Objects.requireNonNull(getCommand("tyrant"), "Missing tyrant command metadata")
.setExecutor(new TyrantCommand(stateManager, new TyrantProgressionService()));
getServer().getPluginManager().registerEvents(
new PlayerJoinListener(stateManager, Clock.systemUTC()),
this
);
getServer().getScheduler().runTaskTimer(this, stateManager::saveIfDirty, 600L, 600L);
getLogger().info("Spigot Tyrant enabled.");
}
@@ -0,0 +1,162 @@
package games.dmg.spigottyrant;
import java.time.Clock;
import java.util.Locale;
import org.bukkit.ChatColor;
import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
public final class TyrantCommand implements CommandExecutor {
private final TyrantStateManager stateManager;
private final TyrantProgressionService progression;
private final ClassAssignmentService assignments;
private final OnlinePlayerDirectory onlinePlayers;
private final Clock clock;
public TyrantCommand(
TyrantStateManager stateManager,
TyrantProgressionService progression
) {
this(
stateManager,
progression,
new ClassAssignmentService(),
new BukkitOnlinePlayerDirectory(),
Clock.systemUTC()
);
}
TyrantCommand(
TyrantStateManager stateManager,
TyrantProgressionService progression,
ClassAssignmentService assignments,
OnlinePlayerDirectory onlinePlayers,
Clock clock
) {
this.stateManager = stateManager;
this.progression = progression;
this.assignments = assignments;
this.onlinePlayers = onlinePlayers;
this.clock = clock;
}
@Override
public boolean onCommand(
CommandSender sender,
Command command,
String label,
String[] arguments
) {
if (!(sender instanceof Player player)) {
sender.sendMessage("This command must be used by a player.");
return true;
}
if (arguments.length == 0 || arguments[0].equalsIgnoreCase("choices")) {
showChoices(player);
return true;
}
if (arguments.length == 2 && arguments[0].equalsIgnoreCase("buy")) {
buy(player, arguments[1]);
return true;
}
if (arguments.length == 3 && arguments[0].equalsIgnoreCase("assign")) {
assign(player, arguments[1], arguments[2]);
return true;
}
player.sendMessage(
ChatColor.YELLOW
+ "Usage: /tyrant choices | /tyrant buy <unlock> | "
+ "/tyrant assign <class> <player>"
);
return true;
}
private void showChoices(Player player) {
GameState state = stateManager.game();
player.sendMessage(ChatColor.GOLD + "Tyrant unlock choices: " + state.unspentChoices());
for (TyrantUnlock unlock : TyrantUnlock.values()) {
String status;
if (state.purchases().contains(unlock)) {
status = "PURCHASED";
} else if (state.lifecycle() == GameLifecycle.RUNNING
&& state.tyrantId().filter(player.getUniqueId()::equals).isPresent()
&& state.unspentChoices() > 0) {
status = "AVAILABLE";
} else {
status = "LOCKED";
}
player.sendMessage(ChatColor.YELLOW + "[" + status + "] " + unlock.name());
}
}
private void buy(Player player, String requestedUnlock) {
TyrantUnlock unlock;
try {
unlock = TyrantUnlock.valueOf(requestedUnlock.toUpperCase(Locale.ROOT));
} catch (IllegalArgumentException exception) {
player.sendMessage(ChatColor.RED + "Unknown unlock. Use /tyrant choices.");
return;
}
PurchaseResult[] result = new PurchaseResult[1];
stateManager.updateGame(current -> {
result[0] = progression.purchase(current, player.getUniqueId(), unlock);
return result[0].state();
});
if (result[0].status() == PurchaseStatus.PURCHASED) {
stateManager.saveIfDirty();
player.sendMessage(ChatColor.GREEN + "Purchased " + unlock.name() + ".");
} else {
player.sendMessage(
ChatColor.RED + "Could not purchase " + unlock.name() + ": "
+ readable(result[0].status())
);
}
}
private void assign(Player tyrant, String requestedClass, String targetName) {
TyrantClass tyrantClass;
try {
tyrantClass = TyrantClass.valueOf(requestedClass.toUpperCase(Locale.ROOT));
} catch (IllegalArgumentException exception) {
tyrant.sendMessage(ChatColor.RED + "Unknown class. Use assassin, fixer, or tamer.");
return;
}
Player target = onlinePlayers.findByName(targetName);
if (target == null) {
tyrant.sendMessage(ChatColor.RED + "That player must be online.");
return;
}
stateManager.player(target.getUniqueId(), target.getName());
ClassAssignmentResult result = assignments.assign(
stateManager.game(),
stateManager.players(),
tyrant.getUniqueId(),
target.getUniqueId(),
tyrantClass,
clock.instant()
);
if (result.status() != ClassAssignmentStatus.ASSIGNED) {
tyrant.sendMessage(
ChatColor.RED + "Could not assign " + tyrantClass.name() + ": "
+ readable(result.status())
);
return;
}
stateManager.replacePlayers(result.players());
stateManager.saveIfDirty();
result.previousHolderId().map(onlinePlayers::findById).ifPresent(previous ->
previous.sendMessage(ChatColor.YELLOW + "You are no longer the "
+ tyrantClass.name() + ".")
);
target.sendMessage(ChatColor.GREEN + "You are now the " + tyrantClass.name() + ".");
tyrant.sendMessage(
ChatColor.GREEN + "Assigned " + tyrantClass.name() + " to " + target.getName() + "."
);
}
private static String readable(Enum<?> status) {
return status.name().toLowerCase(Locale.ROOT).replace('_', ' ');
}
}
@@ -0,0 +1,75 @@
package games.dmg.spigottyrant;
import java.util.Optional;
import java.util.UUID;
public final class TyrantProgressionService {
public GameState recordVigilanteDeath(GameState state, Optional<UUID> killerId) {
if (state.lifecycle() != GameLifecycle.RUNNING
|| state.tyrantId().isEmpty()
|| state.vigilanteId().isEmpty()
|| killerId.isEmpty()
|| !state.tyrantId().orElseThrow().equals(killerId.orElseThrow())) {
return state;
}
return copyProgress(
state,
state.tyrantLevel() + 1,
state.unspentChoices() + 1,
state.purchases()
);
}
public PurchaseResult purchase(
GameState state,
UUID buyerId,
TyrantUnlock unlock
) {
if (state.lifecycle() != GameLifecycle.RUNNING) {
return new PurchaseResult(state, PurchaseStatus.GAME_NOT_RUNNING);
}
if (state.tyrantId().isEmpty() || !state.tyrantId().orElseThrow().equals(buyerId)) {
return new PurchaseResult(state, PurchaseStatus.NOT_TYRANT);
}
if (state.purchases().contains(unlock)) {
return new PurchaseResult(state, PurchaseStatus.ALREADY_PURCHASED);
}
if (state.unspentChoices() == 0) {
return new PurchaseResult(state, PurchaseStatus.NO_CHOICES);
}
java.util.Set<TyrantUnlock> purchases = java.util.EnumSet.noneOf(TyrantUnlock.class);
purchases.addAll(state.purchases());
purchases.add(unlock);
GameState updated = copyProgress(
state,
state.tyrantLevel(),
state.unspentChoices() - 1,
purchases
);
return new PurchaseResult(updated, PurchaseStatus.PURCHASED);
}
public GameState resetReignProgression(GameState state) {
return copyProgress(state, 0, 0, java.util.Set.of());
}
private static GameState copyProgress(
GameState state,
int level,
int choices,
java.util.Set<TyrantUnlock> purchases
) {
return new GameState(
state.lifecycle(),
state.tyrantId(),
state.vigilanteId(),
state.pendingTyrant(),
state.pendingVigilante(),
state.pausedAt(),
state.accumulatedPausedTime(),
level,
choices,
purchases
);
}
}
@@ -64,6 +64,12 @@ public final class TyrantStateManager {
return changed;
}
public void replacePlayers(Map<UUID, PlayerState> replacement) {
players.clear();
players.putAll(replacement);
dirty = true;
}
public GameState updateGame(UnaryOperator<GameState> update) {
game = update.apply(game);
dirty = true;
+4
View File
@@ -4,3 +4,7 @@ main: games.dmg.spigottyrant.SpigotTyrantPlugin
api-version: "1.20"
description: Asymmetric Tyrant, Vigilante, Follower, and specialist class gameplay.
author: dmg.games
commands:
tyrant:
description: View and use Spigot Tyrant game features.
usage: /tyrant [choices|buy <unlock>|assign <class> <player>]
@@ -0,0 +1,29 @@
package games.dmg.spigottyrant;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.UUID;
import org.junit.jupiter.api.Test;
final class ClassAssignmentMessagesTest {
@Test
void loginReminderNamesClassAndControls() {
PlayerState assassin = new PlayerState(
UUID.fromString("11111111-1111-1111-1111-111111111111"),
"Player",
java.util.Optional.empty(),
java.util.Optional.empty(),
TyrantClass.ASSASSIN,
java.util.Optional.empty(),
java.util.Map.of(),
java.util.Set.of(),
java.util.List.of()
);
assertEquals(
"Class: ASSASSIN. Use your Assassin Cloak; double-jump while airborne. "
+ "Use /tyrant item to recover ready class items.",
ClassAssignmentMessages.loginReminder(assassin)
);
}
}
@@ -0,0 +1,127 @@
package games.dmg.spigottyrant;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.time.Duration;
import java.time.Instant;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import org.junit.jupiter.api.Test;
final class ClassAssignmentServiceTest {
private static final UUID TYRANT = UUID.fromString("11111111-1111-1111-1111-111111111111");
private static final UUID VIGILANTE = UUID.fromString("22222222-2222-2222-2222-222222222222");
private static final UUID FOLLOWER = UUID.fromString("33333333-3333-3333-3333-333333333333");
private static final Instant NOW = Instant.parse("2026-08-14T12:00:00Z");
private final ClassAssignmentService service = new ClassAssignmentService();
@Test
void purchasedClassCanBeAssignedToVigilanteOrFollower() {
GameState game = gameWith(TyrantUnlock.ASSASSIN);
PlayerState vigilante = PlayerState.newPlayer(VIGILANTE, "Vigilante");
PlayerState follower = withFollower(
PlayerState.newPlayer(FOLLOWER, "Follower"),
VIGILANTE
);
ClassAssignmentResult vigilanteResult = service.assign(
game,
Map.of(VIGILANTE, vigilante, FOLLOWER, follower),
TYRANT,
VIGILANTE,
TyrantClass.ASSASSIN,
NOW
);
ClassAssignmentResult followerResult = service.assign(
game,
vigilanteResult.players(),
TYRANT,
FOLLOWER,
TyrantClass.ASSASSIN,
NOW
);
assertEquals(ClassAssignmentStatus.ASSIGNED, vigilanteResult.status());
assertEquals(TyrantClass.ASSASSIN,
vigilanteResult.players().get(VIGILANTE).tyrantClass());
assertEquals(ClassAssignmentStatus.ASSIGNED, followerResult.status());
assertEquals(TyrantClass.NONE,
followerResult.players().get(VIGILANTE).tyrantClass());
assertEquals(TyrantClass.ASSASSIN,
followerResult.players().get(FOLLOWER).tyrantClass());
assertEquals(Optional.of(VIGILANTE), followerResult.previousHolderId());
}
@Test
void rejectsLockedSelfAndOptedOutAssignments() {
PlayerState target = PlayerState.newPlayer(FOLLOWER, "Target");
PlayerState optedOut = new PlayerState(
target.playerId(), target.latestName(), target.lastLogin(),
Optional.of(NOW.plusSeconds(60)), target.tyrantClass(), target.followerOf(),
target.cooldownEnds(), target.readyAbilityItems(), target.capturedMobs()
);
assertEquals(ClassAssignmentStatus.CLASS_NOT_UNLOCKED, service.assign(
gameWith(TyrantUnlock.FIXER), Map.of(FOLLOWER, target), TYRANT, FOLLOWER,
TyrantClass.ASSASSIN, NOW
).status());
assertEquals(ClassAssignmentStatus.TARGET_IS_TYRANT, service.assign(
gameWith(TyrantUnlock.ASSASSIN), Map.of(TYRANT,
PlayerState.newPlayer(TYRANT, "Tyrant")), TYRANT, TYRANT,
TyrantClass.ASSASSIN, NOW
).status());
assertEquals(ClassAssignmentStatus.TARGET_OPTED_OUT, service.assign(
gameWith(TyrantUnlock.ASSASSIN), Map.of(FOLLOWER, optedOut), TYRANT,
FOLLOWER, TyrantClass.ASSASSIN, NOW
).status());
}
@Test
void reassignmentAndReignEndClearClassAbilityState() {
Instant cooldown = NOW.plusSeconds(3600);
PlayerState holder = new PlayerState(
VIGILANTE, "Holder", Optional.empty(), Optional.empty(),
TyrantClass.ASSASSIN, Optional.empty(),
Map.of(Ability.ASSASSIN_INVISIBILITY, cooldown),
Set.of(Ability.ASSASSIN_INVISIBILITY), java.util.List.of()
);
PlayerState replacement = PlayerState.newPlayer(FOLLOWER, "Replacement");
ClassAssignmentResult reassigned = service.assign(
gameWith(TyrantUnlock.ASSASSIN),
Map.of(VIGILANTE, holder, FOLLOWER, replacement),
TYRANT, FOLLOWER, TyrantClass.ASSASSIN, NOW
);
PlayerState former = reassigned.players().get(VIGILANTE);
Map<UUID, PlayerState> cleared = service.clearAll(reassigned.players());
assertEquals(Map.of(), former.cooldownEnds());
assertEquals(Set.of(), former.readyAbilityItems());
assertEquals(TyrantClass.NONE, cleared.get(FOLLOWER).tyrantClass());
}
private static GameState gameWith(TyrantUnlock unlock) {
return new GameState(
GameLifecycle.RUNNING,
Optional.of(TYRANT),
Optional.of(VIGILANTE),
Optional.empty(),
Optional.empty(),
Optional.empty(),
Duration.ZERO,
1,
0,
Set.of(unlock)
);
}
private static PlayerState withFollower(PlayerState player, UUID vigilanteId) {
return new PlayerState(
player.playerId(), player.latestName(), player.lastLogin(), player.optedOutUntil(),
player.tyrantClass(), Optional.of(vigilanteId), player.cooldownEnds(),
player.readyAbilityItems(), player.capturedMobs()
);
}
}
@@ -20,6 +20,9 @@ final class PluginMetadataTest {
assertEquals("SpigotTyrant", plugin.get("name"));
assertEquals("games.dmg.spigottyrant.SpigotTyrantPlugin", plugin.get("main"));
assertEquals("1.20", plugin.get("api-version"));
Map<?, ?> commands = (Map<?, ?>) plugin.get("commands");
assertNotNull(commands);
assertNotNull(commands.get("tyrant"));
}
@Test
@@ -0,0 +1,95 @@
package games.dmg.spigottyrant;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.time.Clock;
import java.time.Duration;
import java.time.Instant;
import java.time.ZoneOffset;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import org.bukkit.command.Command;
import org.bukkit.entity.Player;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
final class TyrantCommandTest {
@Test
void choicesClearlyIdentifyPurchasedAvailableAndUnavailableUnlocks() {
UUID tyrantId = UUID.fromString("11111111-1111-1111-1111-111111111111");
GameState state = new GameState(
GameLifecycle.RUNNING,
Optional.of(tyrantId),
Optional.empty(),
Optional.empty(),
Optional.empty(),
Optional.empty(),
Duration.ZERO,
1,
1,
Set.of(TyrantUnlock.STRENGTH)
);
TyrantStateManager manager = mock(TyrantStateManager.class);
when(manager.game()).thenReturn(state);
Player player = mock(Player.class);
when(player.getUniqueId()).thenReturn(tyrantId);
TyrantCommand command = new TyrantCommand(manager, new TyrantProgressionService());
command.onCommand(player, mock(Command.class), "tyrant", new String[] {"choices"});
ArgumentCaptor<String> messages = ArgumentCaptor.forClass(String.class);
verify(player, org.mockito.Mockito.atLeastOnce()).sendMessage(messages.capture());
List<String> all = messages.getAllValues();
assertTrue(all.stream().anyMatch(message -> message.contains("PURCHASED")
&& message.contains("STRENGTH")));
assertTrue(all.stream().anyMatch(message -> message.contains("AVAILABLE")
&& message.contains("ASSASSIN")));
}
@Test
void assigningClassNotifiesTyrantAndNewHolder() {
UUID tyrantId = UUID.fromString("11111111-1111-1111-1111-111111111111");
UUID targetId = UUID.fromString("22222222-2222-2222-2222-222222222222");
GameState game = new GameState(
GameLifecycle.RUNNING, Optional.of(tyrantId), Optional.empty(),
Optional.empty(), Optional.empty(), Optional.empty(), Duration.ZERO,
0, 0, Set.of(TyrantUnlock.FIXER)
);
PlayerState targetState = PlayerState.newPlayer(targetId, "Target");
TyrantStateManager manager = mock(TyrantStateManager.class);
when(manager.game()).thenReturn(game);
when(manager.player(targetId, "Target")).thenReturn(targetState);
when(manager.players()).thenReturn(java.util.Map.of(targetId, targetState));
Player tyrant = mock(Player.class);
when(tyrant.getUniqueId()).thenReturn(tyrantId);
Player target = mock(Player.class);
when(target.getUniqueId()).thenReturn(targetId);
when(target.getName()).thenReturn("Target");
OnlinePlayerDirectory directory = mock(OnlinePlayerDirectory.class);
when(directory.findByName("Target")).thenReturn(target);
TyrantCommand command = new TyrantCommand(
manager,
new TyrantProgressionService(),
new ClassAssignmentService(),
directory,
Clock.fixed(Instant.parse("2026-08-14T12:00:00Z"), ZoneOffset.UTC)
);
command.onCommand(
tyrant,
mock(Command.class),
"tyrant",
new String[] {"assign", "fixer", "Target"}
);
verify(manager).replacePlayers(any());
verify(target).sendMessage(org.mockito.ArgumentMatchers.contains("now the FIXER"));
verify(tyrant).sendMessage(org.mockito.ArgumentMatchers.contains("Assigned FIXER"));
}
}
@@ -0,0 +1,124 @@
package games.dmg.spigottyrant;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.time.Duration;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import org.junit.jupiter.api.Test;
final class TyrantProgressionServiceTest {
private static final UUID TYRANT = UUID.fromString("11111111-1111-1111-1111-111111111111");
private static final UUID VIGILANTE = UUID.fromString("22222222-2222-2222-2222-222222222222");
private static final UUID OTHER = UUID.fromString("33333333-3333-3333-3333-333333333333");
private final TyrantProgressionService service = new TyrantProgressionService();
@Test
void tyrantPersonallyKillingCurrentVigilanteEarnsOneLevelAndChoice() {
GameState before = runningState(0, 1, Set.of());
GameState after = service.recordVigilanteDeath(before, Optional.of(TYRANT));
assertEquals(1, after.tyrantLevel());
assertEquals(2, after.unspentChoices());
}
@Test
void otherEnvironmentalAndPausedDeathsDoNotEarnProgress() {
GameState running = runningState(2, 0, Set.of());
GameState paused = new GameState(
GameLifecycle.PAUSED,
running.tyrantId(),
running.vigilanteId(),
running.pendingTyrant(),
running.pendingVigilante(),
Optional.of(java.time.Instant.parse("2026-08-14T12:00:00Z")),
Duration.ZERO,
2,
0,
Set.of()
);
assertEquals(running, service.recordVigilanteDeath(running, Optional.of(OTHER)));
assertEquals(running, service.recordVigilanteDeath(running, Optional.empty()));
assertEquals(paused, service.recordVigilanteDeath(paused, Optional.of(TYRANT)));
}
@Test
void purchaseConsumesOneChoiceAndCannotBeBoughtTwice() {
GameState before = runningState(1, 2, Set.of());
PurchaseResult first = service.purchase(before, TYRANT, TyrantUnlock.ASSASSIN);
PurchaseResult duplicate = service.purchase(
first.state(), TYRANT, TyrantUnlock.ASSASSIN
);
assertEquals(PurchaseStatus.PURCHASED, first.status());
assertEquals(1, first.state().unspentChoices());
assertTrue(first.state().purchases().contains(TyrantUnlock.ASSASSIN));
assertEquals(PurchaseStatus.ALREADY_PURCHASED, duplicate.status());
assertEquals(first.state(), duplicate.state());
}
@Test
void nonTyrantPausedAndNoChoicePurchasesAreRejected() {
GameState noChoices = runningState(0, 0, Set.of());
GameState paused = new GameState(
GameLifecycle.PAUSED,
noChoices.tyrantId(),
noChoices.vigilanteId(),
noChoices.pendingTyrant(),
noChoices.pendingVigilante(),
Optional.of(java.time.Instant.parse("2026-08-14T12:00:00Z")),
Duration.ZERO,
0,
1,
Set.of()
);
assertEquals(PurchaseStatus.NO_CHOICES,
service.purchase(noChoices, TYRANT, TyrantUnlock.FIXER).status());
assertEquals(PurchaseStatus.NOT_TYRANT,
service.purchase(runningState(0, 1, Set.of()), OTHER, TyrantUnlock.FIXER).status());
PurchaseResult pausedResult = service.purchase(paused, TYRANT, TyrantUnlock.FIXER);
assertEquals(PurchaseStatus.GAME_NOT_RUNNING, pausedResult.status());
assertFalse(pausedResult.state().purchases().contains(TyrantUnlock.FIXER));
}
@Test
void endingReignClearsLevelChoicesAndPurchases() {
GameState progressed = runningState(
4,
2,
Set.of(TyrantUnlock.ASSASSIN, TyrantUnlock.STRENGTH)
);
GameState reset = service.resetReignProgression(progressed);
assertEquals(0, reset.tyrantLevel());
assertEquals(0, reset.unspentChoices());
assertEquals(Set.of(), reset.purchases());
}
private static GameState runningState(
int level,
int choices,
Set<TyrantUnlock> purchases
) {
return new GameState(
GameLifecycle.RUNNING,
Optional.of(TYRANT),
Optional.of(VIGILANTE),
Optional.empty(),
Optional.empty(),
Optional.empty(),
Duration.ZERO,
level,
choices,
purchases
);
}
}