Compare commits

...
2 Commits
Author SHA1 Message Date
dmg ddd256802b feat(succession): transfer tyrant reign on death
Release / release (push) Successful in 2m19s
CI / build (push) Successful in 1m1s
2026-08-14 22:46:58 -04:00
dmg 58e6dec724 feat(admin): add game lifecycle controls
Release / release (push) Successful in 2m12s
CI / build (push) Successful in 57s
2026-08-14 22:42:25 -04:00
25 changed files with 1218 additions and 20 deletions
+22
View File
@@ -6,6 +6,28 @@ description: Chronological record of material decisions affecting the Spigot Tyr
# Spigot Tyrant Design Log
## 2026-08-14 — Tyrant succession completed
- Completed US-002 with player-killer transfer, recent-player environmental succession, former-holder avoidance, pending offline confirmation, and distinct replacement Vigilante selection.
- Tyrant death clears all classes, Followers, cooldowns, item readiness, purchases, levels, and choices before granting the successor one starting choice.
- Added death-event integration, server announcements, and a scoreboard-team-backed red Tyrant name and glowing outline that is restored on login and removed on pause or shutdown.
- Verified succession attribution, random exclusion, reign cleanup, role separation, death integration, and red presentation with the Gradle suite.
## 2026-08-14 — Tyrant succession implementation started
- US-002 begins with test-first killer and environmental succession, reign-wide cleanup, replacement Vigilante selection, and red Tyrant presentation.
## 2026-08-14 — Administrative lifecycle completed
- Completed US-001 with permission-gated `/tyrantadmin` start, status, pause, resume, and confirmed reset operations.
- Initial Vigilantes may be assigned explicitly or selected among eligible recently active players, with offline selections persisted as pending confirmations.
- Pause/resume preserves progression and assignments, shifts every cooldown, participation, inactivity, and pending-selection deadline, and invokes managed effect suppression/restoration.
- Added detailed operator status output and verified lifecycle, timer shifting, permissions, confirmation safety, candidate filtering, metadata, and effect hooks with the Gradle suite.
## 2026-08-14 — Administrative lifecycle implementation started
- US-001 begins with test-first game start, pause/resume deadline freezing, permission-gated administration, inspection, and confirmed reset behavior.
## 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.
@@ -2,7 +2,7 @@
type: User Story
title: "US-001: Start, pause, and administer the game"
description: Give server operators safe control over the Tyrant game's lifecycle and state.
status: backlog
status: done
---
# US-001: Start, pause, and administer the game
@@ -11,14 +11,14 @@ As a **server operator**, I want to start, pause, resume, and inspect the game s
## Acceptance criteria
- [ ] An administrator can start the first game by assigning the initial Tyrant.
- [ ] The administrator may assign the first Vigilante or allow random selection from eligible recently active players.
- [ ] An administrator can pause and resume the game without deleting game state.
- [ ] Pausing freezes progression, cooldowns, daily-use timers, inactivity checks, and pending-selection deadlines.
- [ ] Role and class effects are suppressed while paused and restored when play resumes.
- [ ] Administrative commands require the `spigottyrant.admin` permission, granted to server operators by default.
- [ ] Administrators can inspect lifecycle state, roles, classes, Followers, purchases, levels, cooldowns, participation, and pending selections.
- [ ] Destructive administrative operations require explicit confirmation.
- [x] An administrator can start the first game by assigning the initial Tyrant.
- [x] The administrator may assign the first Vigilante or allow random selection from eligible recently active players.
- [x] An administrator can pause and resume the game without deleting game state.
- [x] Pausing freezes progression, cooldowns, daily-use timers, inactivity checks, and pending-selection deadlines.
- [x] Role and class effects are suppressed while paused and restored when play resumes.
- [x] Administrative commands require the `spigottyrant.admin` permission, granted to server operators by default.
- [x] Administrators can inspect lifecycle state, roles, classes, Followers, purchases, levels, cooldowns, participation, and pending selections.
- [x] Destructive administrative operations require explicit confirmation.
## Related
@@ -2,7 +2,7 @@
type: User Story
title: "US-002: Transfer and reset the Tyrant role"
description: End a Tyrant's reign cleanly and establish a valid successor after death.
status: backlog
status: done
---
# US-002: Transfer and reset the Tyrant role
@@ -11,15 +11,15 @@ As a **player**, I want defeating the Tyrant to transfer power predictably so th
## Acceptance criteria
- [ ] A player directly credited with killing the Tyrant becomes the new Tyrant.
- [ ] A Tyrant death without a player killer selects an eligible opted-in player active within the preceding 24 hours at random.
- [ ] The former Tyrant is excluded from random succession when another eligible candidate exists.
- [ ] The former Tyrant's level, unlocks, unspent choices, and Tyrant ability cooldowns reset when the reign ends.
- [ ] Every Assassin, Fixer, Tamer, Vigilante, and Follower assignment is cleared when the Tyrant dies.
- [ ] A new Vigilante is selected under the normal candidate rules after succession.
- [ ] The new Tyrant receives exactly one starting unlock choice.
- [ ] The Tyrant's displayed name is red and the Tyrant has a red glowing outline while the game is running.
- [ ] Succession cannot assign the same player as both Tyrant and Vigilante.
- [x] A player directly credited with killing the Tyrant becomes the new Tyrant.
- [x] A Tyrant death without a player killer selects an eligible opted-in player active within the preceding 24 hours at random.
- [x] The former Tyrant is excluded from random succession when another eligible candidate exists.
- [x] The former Tyrant's level, unlocks, unspent choices, and Tyrant ability cooldowns reset when the reign ends.
- [x] Every Assassin, Fixer, Tamer, Vigilante, and Follower assignment is cleared when the Tyrant dies.
- [x] A new Vigilante is selected under the normal candidate rules after succession.
- [x] The new Tyrant receives exactly one starting unlock choice.
- [x] The Tyrant's displayed name is red and the Tyrant has a red glowing outline while the game is running.
- [x] Succession cannot assign the same player as both Tyrant and Vigilante.
## Related
@@ -0,0 +1,28 @@
package games.dmg.spigottyrant;
public final class BukkitManagedRoleEffects implements ManagedRoleEffects {
private final TyrantStateManager stateManager;
private final TyrantPresentation presentation;
public BukkitManagedRoleEffects(
TyrantStateManager stateManager,
TyrantPresentation presentation
) {
this.stateManager = stateManager;
this.presentation = presentation;
}
@Override
public void suppressAll() {
presentation.clear();
}
@Override
public void restoreAll() {
if (stateManager.game().lifecycle() == GameLifecycle.RUNNING) {
presentation.reconcile(stateManager.game().tyrantId());
} else {
presentation.clear();
}
}
}
@@ -0,0 +1,55 @@
package games.dmg.spigottyrant;
import java.util.HashSet;
import java.util.Objects;
import java.util.Optional;
import java.util.UUID;
import org.bukkit.ChatColor;
import org.bukkit.Server;
import org.bukkit.entity.Player;
import org.bukkit.scoreboard.Scoreboard;
import org.bukkit.scoreboard.ScoreboardManager;
import org.bukkit.scoreboard.Team;
public final class BukkitTyrantPresentation implements TyrantPresentation {
private static final String TEAM_NAME = "tyrant-red";
private final Server server;
private final Team team;
private Optional<UUID> presentedTyrant = Optional.empty();
public BukkitTyrantPresentation(Server server) {
this.server = server;
ScoreboardManager manager = Objects.requireNonNull(
server.getScoreboardManager(), "Scoreboard manager is unavailable"
);
Scoreboard scoreboard = manager.getMainScoreboard();
Team existing = scoreboard.getTeam(TEAM_NAME);
team = existing == null ? scoreboard.registerNewTeam(TEAM_NAME) : existing;
team.setColor(ChatColor.RED);
}
@Override
public void reconcile(Optional<UUID> tyrantId) {
clear();
presentedTyrant = tyrantId;
tyrantId.map(server::getPlayer).ifPresent(player -> {
team.addEntry(player.getName());
player.setGlowing(true);
player.setPlayerListName(ChatColor.RED + player.getName());
player.setDisplayName(ChatColor.RED + player.getName());
});
}
@Override
public void clear() {
presentedTyrant.map(server::getPlayer).ifPresent(player -> {
player.setGlowing(false);
player.setPlayerListName(player.getName());
player.setDisplayName(player.getName());
});
for (String entry : new HashSet<>(team.getEntries())) {
team.removeEntry(entry);
}
presentedTyrant = Optional.empty();
}
}
@@ -0,0 +1,137 @@
package games.dmg.spigottyrant;
import java.time.Duration;
import java.time.Instant;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
public final class GameLifecycleService {
public LifecycleState start(
PersistentState state,
UUID tyrantId,
Optional<UUID> vigilanteId,
Instant now
) {
if (state.game().lifecycle() != GameLifecycle.UNSTARTED) {
throw new IllegalStateException("game has already been started");
}
if (vigilanteId.filter(tyrantId::equals).isPresent()) {
throw new IllegalArgumentException("Tyrant and Vigilante must be different players");
}
GameState game = new GameState(
GameLifecycle.RUNNING,
Optional.of(tyrantId),
vigilanteId,
Optional.empty(),
Optional.empty(),
Optional.empty(),
Duration.ZERO,
0,
1,
Set.of()
);
return new LifecycleState(game, state.players());
}
public LifecycleState pause(PersistentState state, Instant now) {
if (state.game().lifecycle() != GameLifecycle.RUNNING) {
throw new IllegalStateException("only a running game can be paused");
}
GameState current = state.game();
GameState paused = new GameState(
GameLifecycle.PAUSED,
current.tyrantId(),
current.vigilanteId(),
current.pendingTyrant(),
current.pendingVigilante(),
Optional.of(now),
current.accumulatedPausedTime(),
current.tyrantLevel(),
current.unspentChoices(),
current.purchases()
);
return new LifecycleState(paused, state.players());
}
public LifecycleState resume(PersistentState state, Instant now) {
GameState current = state.game();
if (current.lifecycle() != GameLifecycle.PAUSED || current.pausedAt().isEmpty()) {
throw new IllegalStateException("only a paused game can be resumed");
}
Instant pausedAt = current.pausedAt().orElseThrow();
Duration pausedFor = Duration.between(pausedAt, now);
if (pausedFor.isNegative()) {
throw new IllegalArgumentException("resume time must not precede pause time");
}
GameState resumed = new GameState(
GameLifecycle.RUNNING,
current.tyrantId(),
current.vigilanteId(),
shiftSelection(current.pendingTyrant(), pausedFor),
shiftSelection(current.pendingVigilante(), pausedFor),
Optional.empty(),
current.accumulatedPausedTime().plus(pausedFor),
current.tyrantLevel(),
current.unspentChoices(),
current.purchases()
);
Map<UUID, PlayerState> players = new HashMap<>();
for (PlayerState player : state.players().values()) {
players.put(player.playerId(), shift(player, pausedFor));
}
return new LifecycleState(resumed, players);
}
public LifecycleState reset(PersistentState state) {
Map<UUID, PlayerState> players = new HashMap<>();
for (PlayerState player : state.players().values()) {
players.put(player.playerId(), new PlayerState(
player.playerId(),
player.latestName(),
player.lastLogin(),
player.optedOutUntil(),
TyrantClass.NONE,
Optional.empty(),
Map.of(),
Set.of(),
player.capturedMobs()
));
}
return new LifecycleState(GameState.empty(), players);
}
private static Optional<PendingSelection> shiftSelection(
Optional<PendingSelection> selection,
Duration pausedFor
) {
return selection.map(value -> new PendingSelection(
value.candidateId(), value.expiresAt().plus(pausedFor)
));
}
private static PlayerState shift(PlayerState player, Duration pausedFor) {
Map<Ability, Instant> cooldowns = new EnumMap<>(Ability.class);
player.cooldownEnds().forEach((ability, deadline) ->
cooldowns.put(ability, deadline.plus(pausedFor))
);
return new PlayerState(
player.playerId(),
player.latestName(),
shiftInstant(player.lastLogin(), pausedFor),
shiftInstant(player.optedOutUntil(), pausedFor),
player.tyrantClass(),
player.followerOf(),
cooldowns,
player.readyAbilityItems(),
player.capturedMobs()
);
}
private static Optional<Instant> shiftInstant(Optional<Instant> value, Duration duration) {
return value.map(instant -> instant.plus(duration));
}
}
@@ -0,0 +1,14 @@
package games.dmg.spigottyrant;
import java.util.Map;
import java.util.UUID;
public record LifecycleState(GameState game, Map<UUID, PlayerState> players) {
public LifecycleState {
players = Map.copyOf(players);
}
public PersistentState asPersistentState() {
return new PersistentState(game, players);
}
}
@@ -0,0 +1,7 @@
package games.dmg.spigottyrant;
public interface ManagedRoleEffects {
void suppressAll();
void restoreAll();
}
@@ -0,0 +1,13 @@
package games.dmg.spigottyrant;
public final class NoopManagedRoleEffects implements ManagedRoleEffects {
@Override
public void suppressAll() {
// No managed effects exist until their corresponding abilities are unlocked.
}
@Override
public void restoreAll() {
// No managed effects exist until their corresponding abilities are unlocked.
}
}
@@ -8,10 +8,20 @@ import org.bukkit.event.player.PlayerJoinEvent;
public final class PlayerJoinListener implements Listener {
private final TyrantStateManager stateManager;
private final Clock clock;
private final TyrantPresentation presentation;
public PlayerJoinListener(TyrantStateManager stateManager, Clock clock) {
this(stateManager, clock, null);
}
public PlayerJoinListener(
TyrantStateManager stateManager,
Clock clock,
TyrantPresentation presentation
) {
this.stateManager = stateManager;
this.clock = clock;
this.presentation = presentation;
}
@EventHandler
@@ -29,5 +39,11 @@ public final class PlayerJoinListener implements Listener {
if (!reminder.isEmpty()) {
event.getPlayer().sendMessage(reminder);
}
if (presentation != null
&& stateManager.game().lifecycle() == GameLifecycle.RUNNING
&& stateManager.game().tyrantId()
.filter(event.getPlayer().getUniqueId()::equals).isPresent()) {
presentation.reconcile(stateManager.game().tyrantId());
}
}
}
@@ -0,0 +1,47 @@
package games.dmg.spigottyrant;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.random.RandomGenerator;
public final class RoleCandidateSelector {
public Optional<UUID> select(
Map<UUID, PlayerState> players,
Set<UUID> excluded,
Optional<UUID> previousHolder,
Instant now,
Duration activityWindow,
RandomGenerator random
) {
Instant cutoff = now.minus(activityWindow);
List<UUID> eligible = new ArrayList<>();
for (PlayerState player : players.values()) {
if (excluded.contains(player.playerId())) {
continue;
}
if (player.lastLogin().isEmpty()
|| player.lastLogin().orElseThrow().isBefore(cutoff)) {
continue;
}
if (player.optedOutUntil().filter(deadline -> deadline.isAfter(now)).isPresent()) {
continue;
}
eligible.add(player.playerId());
}
if (eligible.size() > 1) {
previousHolder.ifPresent(eligible::remove);
}
if (eligible.isEmpty()) {
return Optional.empty();
}
eligible.sort(Comparator.comparing(UUID::toString));
return Optional.of(eligible.get(random.nextInt(eligible.size())));
}
}
@@ -10,6 +10,7 @@ import org.bukkit.plugin.java.JavaPlugin;
public final class SpigotTyrantPlugin extends JavaPlugin {
private PluginSettings settings;
private TyrantStateManager stateManager;
private TyrantPresentation tyrantPresentation;
@Override
public void onEnable() {
@@ -27,10 +28,42 @@ public final class SpigotTyrantPlugin extends JavaPlugin {
return;
}
tyrantPresentation = new BukkitTyrantPresentation(getServer());
ManagedRoleEffects managedEffects = new BukkitManagedRoleEffects(
stateManager, tyrantPresentation
);
managedEffects.restoreAll();
Objects.requireNonNull(getCommand("tyrant"), "Missing tyrant command metadata")
.setExecutor(new TyrantCommand(stateManager, new TyrantProgressionService()));
Objects.requireNonNull(getCommand("tyrantadmin"), "Missing tyrantadmin metadata")
.setExecutor(new TyrantAdminCommand(
stateManager,
new GameLifecycleService(),
new BukkitOnlinePlayerDirectory(),
managedEffects,
Clock.systemUTC(),
new RoleCandidateSelector(),
settings.candidateActivityWindow(),
settings.pendingSelectionTimeout(),
java.util.random.RandomGenerator.getDefault()
));
getServer().getPluginManager().registerEvents(
new PlayerJoinListener(stateManager, Clock.systemUTC()),
new PlayerJoinListener(stateManager, Clock.systemUTC(), tyrantPresentation),
this
);
getServer().getPluginManager().registerEvents(
new TyrantDeathListener(
stateManager,
new TyrantSuccessionService(
new RoleCandidateSelector(),
settings.candidateActivityWindow(),
settings.pendingSelectionTimeout(),
java.util.random.RandomGenerator.getDefault()
),
tyrantPresentation,
getServer(),
Clock.systemUTC()
),
this
);
getServer().getScheduler().runTaskTimer(this, stateManager::saveIfDirty, 600L, 600L);
@@ -39,6 +72,9 @@ public final class SpigotTyrantPlugin extends JavaPlugin {
@Override
public void onDisable() {
if (tyrantPresentation != null) {
tyrantPresentation.clear();
}
if (stateManager != null) {
stateManager.saveIfDirty();
}
@@ -0,0 +1,209 @@
package games.dmg.spigottyrant;
import java.time.Clock;
import java.time.Duration;
import java.util.Locale;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.random.RandomGenerator;
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 TyrantAdminCommand implements CommandExecutor {
private static final String PERMISSION = "spigottyrant.admin";
private final TyrantStateManager stateManager;
private final GameLifecycleService lifecycle;
private final OnlinePlayerDirectory onlinePlayers;
private final ManagedRoleEffects effects;
private final Clock clock;
private final RoleCandidateSelector candidateSelector;
private final Duration activityWindow;
private final Duration pendingTimeout;
private final RandomGenerator random;
public TyrantAdminCommand(
TyrantStateManager stateManager,
GameLifecycleService lifecycle,
OnlinePlayerDirectory onlinePlayers,
ManagedRoleEffects effects,
Clock clock
) {
this(
stateManager, lifecycle, onlinePlayers, effects, clock,
new RoleCandidateSelector(), Duration.ofHours(24), Duration.ofHours(24),
RandomGenerator.getDefault()
);
}
public TyrantAdminCommand(
TyrantStateManager stateManager,
GameLifecycleService lifecycle,
OnlinePlayerDirectory onlinePlayers,
ManagedRoleEffects effects,
Clock clock,
RoleCandidateSelector candidateSelector,
Duration activityWindow,
Duration pendingTimeout,
RandomGenerator random
) {
this.stateManager = stateManager;
this.lifecycle = lifecycle;
this.onlinePlayers = onlinePlayers;
this.effects = effects;
this.clock = clock;
this.candidateSelector = candidateSelector;
this.activityWindow = activityWindow;
this.pendingTimeout = pendingTimeout;
this.random = random;
}
@Override
public boolean onCommand(
CommandSender sender,
Command command,
String label,
String[] arguments
) {
if (!sender.hasPermission(PERMISSION)) {
sender.sendMessage(ChatColor.RED + "You do not have permission to administer Tyrant.");
return true;
}
if (arguments.length == 0 || arguments[0].equalsIgnoreCase("status")) {
showStatus(sender);
return true;
}
try {
switch (arguments[0].toLowerCase(Locale.ROOT)) {
case "start" -> start(sender, arguments);
case "pause" -> pause(sender);
case "resume" -> resume(sender);
case "reset" -> reset(sender, arguments);
default -> usage(sender);
}
} catch (IllegalArgumentException | IllegalStateException exception) {
sender.sendMessage(ChatColor.RED + exception.getMessage());
}
return true;
}
private void start(CommandSender sender, String[] arguments) {
if (arguments.length < 2 || arguments.length > 3) {
sender.sendMessage(ChatColor.YELLOW
+ "Usage: /tyrantadmin start <tyrant> [vigilante]");
return;
}
Player tyrant = onlinePlayers.findByName(arguments[1]);
if (tyrant == null) {
sender.sendMessage(ChatColor.RED + "The initial Tyrant must be online.");
return;
}
Optional<Player> vigilante = Optional.empty();
if (arguments.length == 3) {
vigilante = Optional.ofNullable(onlinePlayers.findByName(arguments[2]));
if (vigilante.isEmpty()) {
sender.sendMessage(ChatColor.RED + "The initial Vigilante must be online.");
return;
}
}
stateManager.player(tyrant.getUniqueId(), tyrant.getName());
vigilante.ifPresent(player -> stateManager.player(player.getUniqueId(), player.getName()));
InstantHolder now = new InstantHolder(clock.instant());
Optional<UUID> randomCandidate = vigilante.isEmpty()
? candidateSelector.select(
stateManager.players(), Set.of(tyrant.getUniqueId()), Optional.empty(),
now.value(), activityWindow, random
)
: Optional.empty();
Optional<UUID> activeVigilante = vigilante.map(Player::getUniqueId);
if (activeVigilante.isEmpty() && randomCandidate.isPresent()
&& onlinePlayers.findById(randomCandidate.orElseThrow()) != null) {
activeVigilante = randomCandidate;
}
LifecycleState started = lifecycle.start(
stateManager.snapshot(), tyrant.getUniqueId(), activeVigilante, now.value()
);
if (activeVigilante.isEmpty() && randomCandidate.isPresent()) {
GameState game = started.game();
started = new LifecycleState(new GameState(
game.lifecycle(), game.tyrantId(), game.vigilanteId(), game.pendingTyrant(),
Optional.of(new PendingSelection(
randomCandidate.orElseThrow(), now.value().plus(pendingTimeout)
)),
game.pausedAt(), game.accumulatedPausedTime(), game.tyrantLevel(),
game.unspentChoices(), game.purchases()
), started.players());
}
stateManager.replaceState(started);
stateManager.saveIfDirty();
effects.restoreAll();
sender.sendMessage(ChatColor.GREEN + "Tyrant game started.");
if (vigilante.isEmpty()) {
sender.sendMessage(ChatColor.YELLOW
+ "An eligible recently active Vigilante will be selected automatically.");
}
}
private void pause(CommandSender sender) {
LifecycleState paused = lifecycle.pause(stateManager.snapshot(), clock.instant());
stateManager.replaceState(paused);
stateManager.saveIfDirty();
effects.suppressAll();
sender.sendMessage(ChatColor.GREEN + "Tyrant game paused.");
}
private void resume(CommandSender sender) {
LifecycleState resumed = lifecycle.resume(stateManager.snapshot(), clock.instant());
stateManager.replaceState(resumed);
stateManager.saveIfDirty();
effects.restoreAll();
sender.sendMessage(ChatColor.GREEN + "Tyrant game resumed.");
}
private void reset(CommandSender sender, String[] arguments) {
if (arguments.length != 2 || !arguments[1].equalsIgnoreCase("confirm")) {
sender.sendMessage(ChatColor.RED
+ "This clears the game. Use /tyrantadmin reset confirm.");
return;
}
stateManager.replaceState(lifecycle.reset(stateManager.snapshot()));
stateManager.saveIfDirty();
effects.suppressAll();
sender.sendMessage(ChatColor.GREEN + "Tyrant game reset.");
}
private void showStatus(CommandSender sender) {
GameState game = stateManager.game();
sender.sendMessage(ChatColor.GOLD + "Lifecycle: " + game.lifecycle());
sender.sendMessage("Tyrant: " + game.tyrantId().map(Object::toString).orElse("none"));
sender.sendMessage("Vigilante: "
+ game.vigilanteId().map(Object::toString).orElse("none"));
sender.sendMessage("Level: " + game.tyrantLevel()
+ ", choices: " + game.unspentChoices()
+ ", purchases: " + game.purchases());
sender.sendMessage("Pending Tyrant: " + game.pendingTyrant());
sender.sendMessage("Pending Vigilante: " + game.pendingVigilante());
for (PlayerState player : stateManager.players().values()) {
boolean optedOut = player.optedOutUntil()
.filter(deadline -> deadline.isAfter(clock.instant()))
.isPresent();
sender.sendMessage(
player.latestName() + " (" + player.playerId() + "): class="
+ player.tyrantClass() + ", followerOf="
+ player.followerOf().map(Object::toString).orElse("none")
+ ", optedOut=" + optedOut + ", cooldowns=" + player.cooldownEnds()
);
}
}
private record InstantHolder(java.time.Instant value) {
}
private static void usage(CommandSender sender) {
sender.sendMessage(ChatColor.YELLOW
+ "Usage: /tyrantadmin <status|start|pause|resume|reset confirm>");
}
}
@@ -0,0 +1,65 @@
package games.dmg.spigottyrant;
import java.time.Clock;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;
import org.bukkit.ChatColor;
import org.bukkit.Server;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.entity.PlayerDeathEvent;
public final class TyrantDeathListener implements Listener {
private final TyrantStateManager stateManager;
private final TyrantSuccessionService succession;
private final TyrantPresentation presentation;
private final Server server;
private final Clock clock;
public TyrantDeathListener(
TyrantStateManager stateManager,
TyrantSuccessionService succession,
TyrantPresentation presentation,
Server server,
Clock clock
) {
this.stateManager = stateManager;
this.succession = succession;
this.presentation = presentation;
this.server = server;
this.clock = clock;
}
@EventHandler(priority = EventPriority.MONITOR)
public void onDeath(PlayerDeathEvent event) {
UUID victimId = event.getEntity().getUniqueId();
GameState game = stateManager.game();
if (game.lifecycle() != GameLifecycle.RUNNING
|| game.tyrantId().filter(victimId::equals).isEmpty()) {
return;
}
Optional<UUID> killerId = Optional.ofNullable(event.getEntity().getKiller())
.map(Player::getUniqueId);
Set<UUID> online = server.getOnlinePlayers().stream()
.map(Player::getUniqueId)
.collect(Collectors.toUnmodifiableSet());
LifecycleState succeeded = succession.succeed(
stateManager.snapshot(), killerId, online, clock.instant()
);
stateManager.replaceState(succeeded);
stateManager.saveIfDirty();
presentation.reconcile(succeeded.game().tyrantId());
String successor = succeeded.game().tyrantId()
.map(id -> {
Player player = server.getPlayer(id);
return player == null ? id.toString() : player.getName();
})
.orElse("pending selection");
String message = ChatColor.RED + successor + " is the new Tyrant!";
server.getOnlinePlayers().forEach(player -> player.sendMessage(message));
}
}
@@ -0,0 +1,10 @@
package games.dmg.spigottyrant;
import java.util.Optional;
import java.util.UUID;
public interface TyrantPresentation {
void reconcile(Optional<UUID> tyrantId);
void clear();
}
@@ -76,6 +76,17 @@ public final class TyrantStateManager {
return game;
}
public void replaceState(LifecycleState replacement) {
game = replacement.game();
players.clear();
players.putAll(replacement.players());
dirty = true;
}
public PersistentState snapshot() {
return new PersistentState(game, players);
}
public boolean saveIfDirty() {
if (!dirty) {
return true;
@@ -0,0 +1,109 @@
package games.dmg.spigottyrant;
import java.time.Duration;
import java.time.Instant;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.random.RandomGenerator;
public final class TyrantSuccessionService {
private final RoleCandidateSelector candidates;
private final Duration activityWindow;
private final Duration pendingTimeout;
private final RandomGenerator random;
public TyrantSuccessionService(
RoleCandidateSelector candidates,
Duration activityWindow,
Duration pendingTimeout,
RandomGenerator random
) {
this.candidates = candidates;
this.activityWindow = activityWindow;
this.pendingTimeout = pendingTimeout;
this.random = random;
}
public LifecycleState succeed(
PersistentState state,
Optional<UUID> killerId,
Set<UUID> onlinePlayerIds,
Instant now
) {
if (state.game().lifecycle() != GameLifecycle.RUNNING
|| state.game().tyrantId().isEmpty()) {
throw new IllegalStateException("a running Tyrant reign is required");
}
UUID formerTyrant = state.game().tyrantId().orElseThrow();
Optional<UUID> formerVigilante = state.game().vigilanteId();
Map<UUID, PlayerState> clearedPlayers = clearAssignments(state.players());
Optional<UUID> selectedTyrant = killerId.isPresent()
? killerId
: candidates.select(
clearedPlayers,
Set.of(),
Optional.of(formerTyrant),
now,
activityWindow,
random
);
Optional<UUID> activeTyrant = selectedTyrant
.filter(playerId -> killerId.isPresent() || onlinePlayerIds.contains(playerId));
Optional<PendingSelection> pendingTyrant = selectedTyrant
.filter(playerId -> activeTyrant.isEmpty())
.map(playerId -> new PendingSelection(playerId, now.plus(pendingTimeout)));
Optional<UUID> selectedVigilante = activeTyrant.flatMap(tyrantId ->
candidates.select(
clearedPlayers,
Set.of(tyrantId),
formerVigilante,
now,
activityWindow,
random
)
);
Optional<UUID> activeVigilante = selectedVigilante
.filter(onlinePlayerIds::contains);
Optional<PendingSelection> pendingVigilante = selectedVigilante
.filter(playerId -> activeVigilante.isEmpty())
.map(playerId -> new PendingSelection(playerId, now.plus(pendingTimeout)));
GameState game = new GameState(
GameLifecycle.RUNNING,
activeTyrant,
activeVigilante,
pendingTyrant,
pendingVigilante,
Optional.empty(),
state.game().accumulatedPausedTime(),
0,
1,
Set.of()
);
return new LifecycleState(game, clearedPlayers);
}
private static Map<UUID, PlayerState> clearAssignments(
Map<UUID, PlayerState> players
) {
Map<UUID, PlayerState> cleared = new HashMap<>();
for (PlayerState player : players.values()) {
cleared.put(player.playerId(), new PlayerState(
player.playerId(),
player.latestName(),
player.lastLogin(),
player.optedOutUntil(),
TyrantClass.NONE,
Optional.empty(),
Map.of(),
Set.of(),
player.capturedMobs()
));
}
return Map.copyOf(cleared);
}
}
+8
View File
@@ -8,3 +8,11 @@ commands:
tyrant:
description: View and use Spigot Tyrant game features.
usage: /tyrant [choices|buy <unlock>|assign <class> <player>]
tyrantadmin:
description: Administer the Spigot Tyrant game.
usage: /tyrantadmin <status|start|pause|resume|reset confirm>
permission: spigottyrant.admin
permissions:
spigottyrant.admin:
description: Allows administration of Spigot Tyrant.
default: op
@@ -0,0 +1,42 @@
package games.dmg.spigottyrant;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.util.Optional;
import java.util.UUID;
import org.bukkit.ChatColor;
import org.bukkit.Server;
import org.bukkit.entity.Player;
import org.bukkit.scoreboard.Scoreboard;
import org.bukkit.scoreboard.ScoreboardManager;
import org.bukkit.scoreboard.Team;
import org.junit.jupiter.api.Test;
final class BukkitTyrantPresentationTest {
@Test
void givesCurrentTyrantRedNameAndGlowingOutline() {
UUID tyrantId = UUID.fromString("11111111-1111-1111-1111-111111111111");
Server server = mock(Server.class);
ScoreboardManager manager = mock(ScoreboardManager.class);
Scoreboard scoreboard = mock(Scoreboard.class);
Team team = mock(Team.class);
Player tyrant = mock(Player.class);
when(server.getScoreboardManager()).thenReturn(manager);
when(manager.getMainScoreboard()).thenReturn(scoreboard);
when(scoreboard.getTeam("tyrant-red")).thenReturn(null);
when(scoreboard.registerNewTeam("tyrant-red")).thenReturn(team);
when(server.getPlayer(tyrantId)).thenReturn(tyrant);
when(tyrant.getName()).thenReturn("TyrantPlayer");
BukkitTyrantPresentation presentation = new BukkitTyrantPresentation(server);
presentation.reconcile(Optional.of(tyrantId));
verify(team).setColor(ChatColor.RED);
verify(team).addEntry("TyrantPlayer");
verify(tyrant).setGlowing(true);
verify(tyrant).setPlayerListName(ChatColor.RED + "TyrantPlayer");
verify(tyrant).setDisplayName(ChatColor.RED + "TyrantPlayer");
}
}
@@ -0,0 +1,65 @@
package games.dmg.spigottyrant;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
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 GameLifecycleServiceTest {
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 Instant START = Instant.parse("2026-08-14T12:00:00Z");
private final GameLifecycleService service = new GameLifecycleService();
@Test
void startsFirstGameWithInitialRolesAndChoice() {
LifecycleState started = service.start(
PersistentState.empty(), TYRANT, Optional.of(VIGILANTE), START
);
assertEquals(GameLifecycle.RUNNING, started.game().lifecycle());
assertEquals(Optional.of(TYRANT), started.game().tyrantId());
assertEquals(Optional.of(VIGILANTE), started.game().vigilanteId());
assertEquals(1, started.game().unspentChoices());
}
@Test
void pauseAndResumePreserveStateAndShiftEveryElapsedDeadline() {
Instant cooldown = START.plusSeconds(600);
PlayerState player = new PlayerState(
TYRANT, "Tyrant", Optional.of(START.minusSeconds(60)),
Optional.of(START.plusSeconds(1200)), TyrantClass.ASSASSIN,
Optional.empty(), Map.of(Ability.ASSASSIN_INVISIBILITY, cooldown),
Set.of(), java.util.List.of()
);
GameState running = new GameState(
GameLifecycle.RUNNING, Optional.of(TYRANT), Optional.of(VIGILANTE),
Optional.empty(), Optional.of(new PendingSelection(VIGILANTE, cooldown)),
Optional.empty(), Duration.ofMinutes(2), 2, 1,
Set.of(TyrantUnlock.ASSASSIN)
);
LifecycleState paused = service.pause(
new PersistentState(running, Map.of(TYRANT, player)), START
);
Instant resumedAt = START.plusSeconds(300);
LifecycleState resumed = service.resume(paused.asPersistentState(), resumedAt);
assertEquals(GameLifecycle.RUNNING, resumed.game().lifecycle());
assertEquals(Duration.ofMinutes(7), resumed.game().accumulatedPausedTime());
assertEquals(cooldown.plusSeconds(300),
resumed.game().pendingVigilante().orElseThrow().expiresAt());
PlayerState shifted = resumed.players().get(TYRANT);
assertEquals(cooldown.plusSeconds(300),
shifted.cooldownEnds().get(Ability.ASSASSIN_INVISIBILITY));
assertEquals(START.plusSeconds(1500), shifted.optedOutUntil().orElseThrow());
assertEquals(START.plusSeconds(240), shifted.lastLogin().orElseThrow());
assertTrue(shifted.tyrantClass() == TyrantClass.ASSASSIN);
}
}
@@ -23,6 +23,11 @@ final class PluginMetadataTest {
Map<?, ?> commands = (Map<?, ?>) plugin.get("commands");
assertNotNull(commands);
assertNotNull(commands.get("tyrant"));
assertNotNull(commands.get("tyrantadmin"));
Map<?, ?> permissions = (Map<?, ?>) plugin.get("permissions");
assertNotNull(permissions);
Map<?, ?> admin = (Map<?, ?>) permissions.get("spigottyrant.admin");
assertEquals("op", admin.get("default"));
}
@Test
@@ -0,0 +1,46 @@
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 java.util.random.RandomGenerator;
import org.junit.jupiter.api.Test;
final class RoleCandidateSelectorTest {
@Test
void selectsOnlyRecentlyActiveEligibleNonExcludedPlayer() {
Instant now = Instant.parse("2026-08-14T12:00:00Z");
UUID tyrant = UUID.fromString("11111111-1111-1111-1111-111111111111");
UUID candidate = UUID.fromString("22222222-2222-2222-2222-222222222222");
UUID stale = UUID.fromString("33333333-3333-3333-3333-333333333333");
Map<UUID, PlayerState> players = Map.of(
tyrant, withLogin(PlayerState.newPlayer(tyrant, "Tyrant"), now),
candidate, withLogin(PlayerState.newPlayer(candidate, "Candidate"), now.minusSeconds(60)),
stale, withLogin(PlayerState.newPlayer(stale, "Stale"), now.minus(Duration.ofHours(25)))
);
Optional<UUID> selected = new RoleCandidateSelector().select(
players,
Set.of(tyrant),
Optional.empty(),
now,
Duration.ofHours(24),
RandomGenerator.of("L64X128MixRandom")
);
assertEquals(Optional.of(candidate), selected);
}
private static PlayerState withLogin(PlayerState player, Instant login) {
return new PlayerState(
player.playerId(), player.latestName(), Optional.of(login), player.optedOutUntil(),
player.tyrantClass(), player.followerOf(), player.cooldownEnds(),
player.readyAbilityItems(), player.capturedMobs()
);
}
}
@@ -0,0 +1,87 @@
package games.dmg.spigottyrant;
import static org.mockito.ArgumentMatchers.contains;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
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.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.junit.jupiter.api.Test;
final class TyrantAdminCommandTest {
@Test
void rejectsSenderWithoutAdminPermission() {
TyrantStateManager manager = mock(TyrantStateManager.class);
CommandSender sender = mock(CommandSender.class);
when(sender.hasPermission("spigottyrant.admin")).thenReturn(false);
TyrantAdminCommand command = command(manager, mock(ManagedRoleEffects.class));
command.onCommand(sender, mock(Command.class), "tyrantadmin", new String[] {"pause"});
verify(sender).sendMessage(contains("permission"));
verify(manager, never()).replaceState(org.mockito.ArgumentMatchers.any());
}
@Test
void pausePreservesStateAndSuppressesManagedEffects() {
UUID tyrant = UUID.fromString("11111111-1111-1111-1111-111111111111");
GameState game = new GameState(
GameLifecycle.RUNNING, Optional.of(tyrant), Optional.empty(),
Optional.empty(), Optional.empty(), Optional.empty(), Duration.ZERO,
2, 1, Set.of(TyrantUnlock.STRENGTH)
);
PersistentState snapshot = new PersistentState(
game, Map.of(tyrant, PlayerState.newPlayer(tyrant, "Tyrant"))
);
TyrantStateManager manager = mock(TyrantStateManager.class);
when(manager.snapshot()).thenReturn(snapshot);
ManagedRoleEffects effects = mock(ManagedRoleEffects.class);
CommandSender sender = mock(CommandSender.class);
when(sender.hasPermission("spigottyrant.admin")).thenReturn(true);
TyrantAdminCommand command = command(manager, effects);
command.onCommand(sender, mock(Command.class), "tyrantadmin", new String[] {"pause"});
verify(manager).replaceState(org.mockito.ArgumentMatchers.argThat(
state -> state.game().lifecycle() == GameLifecycle.PAUSED
&& state.game().tyrantLevel() == 2
));
verify(effects).suppressAll();
}
@Test
void resetRequiresExplicitConfirmation() {
TyrantStateManager manager = mock(TyrantStateManager.class);
CommandSender sender = mock(CommandSender.class);
when(sender.hasPermission("spigottyrant.admin")).thenReturn(true);
TyrantAdminCommand command = command(manager, mock(ManagedRoleEffects.class));
command.onCommand(sender, mock(Command.class), "tyrantadmin", new String[] {"reset"});
verify(sender).sendMessage(contains("reset confirm"));
verify(manager, never()).replaceState(org.mockito.ArgumentMatchers.any());
}
private static TyrantAdminCommand command(
TyrantStateManager manager,
ManagedRoleEffects effects
) {
return new TyrantAdminCommand(
manager,
new GameLifecycleService(),
mock(OnlinePlayerDirectory.class),
effects,
Clock.fixed(Instant.parse("2026-08-14T12:00:00Z"), ZoneOffset.UTC)
);
}
}
@@ -0,0 +1,71 @@
package games.dmg.spigottyrant;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
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.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import org.bukkit.Server;
import org.bukkit.entity.Player;
import org.bukkit.event.entity.PlayerDeathEvent;
import org.junit.jupiter.api.Test;
final class TyrantDeathListenerTest {
@Test
void tyrantDeathAppliesSuccessionAndPresentation() {
UUID tyrantId = UUID.fromString("11111111-1111-1111-1111-111111111111");
UUID killerId = 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, 1, Set.of()
);
PersistentState before = new PersistentState(game, Map.of());
GameState succeededGame = new GameState(
GameLifecycle.RUNNING, Optional.of(killerId), Optional.empty(),
Optional.empty(), Optional.empty(), Optional.empty(), Duration.ZERO,
0, 1, Set.of()
);
LifecycleState succeeded = new LifecycleState(succeededGame, Map.of());
TyrantStateManager manager = mock(TyrantStateManager.class);
when(manager.game()).thenReturn(game);
when(manager.snapshot()).thenReturn(before);
TyrantSuccessionService succession = mock(TyrantSuccessionService.class);
when(succession.succeed(eq(before), eq(Optional.of(killerId)), any(), any()))
.thenReturn(succeeded);
TyrantPresentation presentation = mock(TyrantPresentation.class);
Server server = mock(Server.class);
Player victim = mock(Player.class);
when(victim.getUniqueId()).thenReturn(tyrantId);
Player killer = mock(Player.class);
when(killer.getUniqueId()).thenReturn(killerId);
when(victim.getKiller()).thenReturn(killer);
doReturn(List.of(victim, killer)).when(server).getOnlinePlayers();
PlayerDeathEvent event = mock(PlayerDeathEvent.class);
when(event.getEntity()).thenReturn(victim);
TyrantDeathListener listener = new TyrantDeathListener(
manager,
succession,
presentation,
server,
Clock.fixed(Instant.parse("2026-08-14T12:00:00Z"), ZoneOffset.UTC)
);
listener.onDeath(event);
verify(manager).replaceState(succeeded);
verify(presentation).reconcile(Optional.of(killerId));
verify(killer).sendMessage(org.mockito.ArgumentMatchers.contains("new Tyrant"));
}
}
@@ -0,0 +1,95 @@
package games.dmg.spigottyrant;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
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 java.util.random.RandomGenerator;
import org.junit.jupiter.api.Test;
final class TyrantSuccessionServiceTest {
private static final UUID OLD_TYRANT = UUID.fromString("11111111-1111-1111-1111-111111111111");
private static final UUID OLD_VIGILANTE = UUID.fromString("22222222-2222-2222-2222-222222222222");
private static final UUID KILLER = UUID.fromString("33333333-3333-3333-3333-333333333333");
private static final UUID OTHER = UUID.fromString("44444444-4444-4444-4444-444444444444");
private static final Instant NOW = Instant.parse("2026-08-14T12:00:00Z");
private final TyrantSuccessionService service = new TyrantSuccessionService(
new RoleCandidateSelector(),
Duration.ofHours(24),
Duration.ofHours(24),
RandomGenerator.of("L64X128MixRandom")
);
@Test
void playerKillerBecomesTyrantAndEntireReignIsReset() {
PersistentState before = progressedState();
LifecycleState after = service.succeed(
before, Optional.of(KILLER), Set.of(KILLER, OTHER), NOW
);
assertEquals(Optional.of(KILLER), after.game().tyrantId());
assertEquals(0, after.game().tyrantLevel());
assertEquals(1, after.game().unspentChoices());
assertEquals(Set.of(), after.game().purchases());
assertNotEquals(after.game().tyrantId(), after.game().vigilanteId());
for (PlayerState player : after.players().values()) {
assertEquals(TyrantClass.NONE, player.tyrantClass());
assertEquals(Optional.empty(), player.followerOf());
assertEquals(Map.of(), player.cooldownEnds());
}
}
@Test
void environmentalDeathRandomlySelectsRecentPlayerInsteadOfFormerTyrant() {
PersistentState before = progressedState();
LifecycleState after = service.succeed(before, Optional.empty(), Set.of(OTHER), NOW);
UUID selected = after.game().tyrantId().orElseGet(() ->
after.game().pendingTyrant().orElseThrow().candidateId()
);
assertNotEquals(OLD_TYRANT, selected);
}
private static PersistentState progressedState() {
GameState game = new GameState(
GameLifecycle.RUNNING, Optional.of(OLD_TYRANT), Optional.of(OLD_VIGILANTE),
Optional.empty(), Optional.empty(), Optional.empty(), Duration.ZERO,
5, 2, Set.of(TyrantUnlock.ASSASSIN, TyrantUnlock.STRENGTH)
);
Map<UUID, PlayerState> players = Map.of(
OLD_TYRANT, active(new PlayerState(
OLD_TYRANT, "OldTyrant", Optional.empty(), Optional.empty(),
TyrantClass.NONE, Optional.empty(),
Map.of(Ability.ROSTER_INTELLIGENCE, NOW.plusSeconds(20)),
Set.of(), java.util.List.of()
)),
OLD_VIGILANTE, active(new PlayerState(
OLD_VIGILANTE, "OldVigilante", Optional.empty(), Optional.empty(),
TyrantClass.ASSASSIN, Optional.empty(),
Map.of(Ability.ASSASSIN_INVISIBILITY, NOW.plusSeconds(20)),
Set.of(Ability.ASSASSIN_INVISIBILITY), java.util.List.of()
)),
KILLER, active(PlayerState.newPlayer(KILLER, "Killer")),
OTHER, active(new PlayerState(
OTHER, "Other", Optional.empty(), Optional.empty(), TyrantClass.FIXER,
Optional.of(OLD_VIGILANTE), Map.of(), Set.of(), java.util.List.of()
))
);
return new PersistentState(game, players);
}
private static PlayerState active(PlayerState player) {
return new PlayerState(
player.playerId(), player.latestName(), Optional.of(NOW.minusSeconds(60)),
player.optedOutUntil(), player.tyrantClass(), player.followerOf(),
player.cooldownEnds(), player.readyAbilityItems(), player.capturedMobs()
);
}
}