feat(participation): add opt-out and role status

src/main/java/games/dmg/spigottyrant/BukkitOnlinePlayerDirectory.java

@@ -14,4 +14,11 @@ public final class BukkitOnlinePlayerDirectory implements OnlinePlayerDirectory
     public Player findById(UUID playerId) {
         return Bukkit.getPlayer(playerId);
     }
+
+    @Override
+    public java.util.Set<UUID> onlinePlayerIds() {
+        return Bukkit.getOnlinePlayers().stream()
+            .map(Player::getUniqueId)
+            .collect(java.util.stream.Collectors.toUnmodifiableSet());
+    }
 }

src/main/java/games/dmg/spigottyrant/ClassAssignmentService.java

@@ -78,7 +78,7 @@ public final class ClassAssignmentService {
         if (targetId.equals(assignerId)) {
             return ClassAssignmentStatus.TARGET_IS_TYRANT;
         }
-        if (target.optedOutUntil().filter(until -> until.isAfter(now)).isPresent()) {
+        if (target.optedOutUntil().isPresent()) {
             return ClassAssignmentStatus.TARGET_OPTED_OUT;
         }
         return null;

src/main/java/games/dmg/spigottyrant/OnlinePlayerDirectory.java

@@ -7,4 +7,6 @@ public interface OnlinePlayerDirectory {
     Player findByName(String name);
 
     Player findById(UUID playerId);
+
+    java.util.Set<UUID> onlinePlayerIds();
 }

src/main/java/games/dmg/spigottyrant/ParticipationResult.java

@@ -0,0 +1,4 @@
+package games.dmg.spigottyrant;
+
+public record ParticipationResult(PlayerState player, ParticipationStatus status) {
+}

src/main/java/games/dmg/spigottyrant/ParticipationService.java

@@ -0,0 +1,68 @@
+package games.dmg.spigottyrant;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+
+public final class ParticipationService {
+    private final Duration optOutDuration;
+
+    public ParticipationService(Duration optOutDuration) {
+        if (optOutDuration.isNegative() || optOutDuration.isZero()) {
+            throw new IllegalArgumentException("optOutDuration must be positive");
+        }
+        this.optOutDuration = optOutDuration;
+    }
+
+    public ParticipationResult optOut(GameState game, PlayerState player, Instant now) {
+        if (game.tyrantId().filter(player.playerId()::equals).isPresent()
+                || game.vigilanteId().filter(player.playerId()::equals).isPresent()) {
+            return new ParticipationResult(
+                player, ParticipationStatus.MUST_RELINQUISH_ROLE
+            );
+        }
+        if (player.optedOutUntil().isPresent()) {
+            return new ParticipationResult(player, ParticipationStatus.ALREADY_OPTED_OUT);
+        }
+        PlayerState updated = new PlayerState(
+            player.playerId(),
+            player.latestName(),
+            player.lastLogin(),
+            Optional.of(now.plus(optOutDuration)),
+            TyrantClass.NONE,
+            Optional.empty(),
+            Map.of(),
+            Set.of(),
+            player.capturedMobs()
+        );
+        return new ParticipationResult(updated, ParticipationStatus.OPTED_OUT);
+    }
+
+    public ParticipationResult optIn(PlayerState player, Instant now) {
+        if (player.optedOutUntil().isEmpty()) {
+            return new ParticipationResult(player, ParticipationStatus.ALREADY_OPTED_IN);
+        }
+        if (now.isBefore(player.optedOutUntil().orElseThrow())) {
+            return new ParticipationResult(player, ParticipationStatus.COOLDOWN_ACTIVE);
+        }
+        PlayerState updated = new PlayerState(
+            player.playerId(),
+            player.latestName(),
+            player.lastLogin(),
+            Optional.empty(),
+            player.tyrantClass(),
+            player.followerOf(),
+            player.cooldownEnds(),
+            player.readyAbilityItems(),
+            player.capturedMobs()
+        );
+        return new ParticipationResult(updated, ParticipationStatus.OPTED_IN);
+    }
+
+    public ParticipationStatus status(PlayerState player, Instant now) {
+        return player.optedOutUntil().isPresent()
+            ? ParticipationStatus.OPTED_OUT : ParticipationStatus.OPTED_IN;
+    }
+}

src/main/java/games/dmg/spigottyrant/ParticipationStatus.java

@@ -0,0 +1,10 @@
+package games.dmg.spigottyrant;
+
+public enum ParticipationStatus {
+    OPTED_IN,
+    OPTED_OUT,
+    COOLDOWN_ACTIVE,
+    MUST_RELINQUISH_ROLE,
+    ALREADY_OPTED_IN,
+    ALREADY_OPTED_OUT
+}

src/main/java/games/dmg/spigottyrant/PlayerJoinListener.java

@@ -35,9 +35,10 @@ public final class PlayerJoinListener implements Listener {
                 current.cooldownEnds(), current.readyAbilityItems(), current.capturedMobs()
             )
         );
-        String reminder = ClassAssignmentMessages.loginReminder(player);
-        if (!reminder.isEmpty()) {
-            event.getPlayer().sendMessage(reminder);
+        for (String message : PlayerStatusMessages.forJoin(
+            stateManager.game(), player, clock.instant()
+        )) {
+            event.getPlayer().sendMessage(message);
         }
         if (presentation != null
                 && stateManager.game().lifecycle() == GameLifecycle.RUNNING

src/main/java/games/dmg/spigottyrant/PlayerStatusMessages.java

@@ -0,0 +1,53 @@
+package games.dmg.spigottyrant;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+
+public final class PlayerStatusMessages {
+    private PlayerStatusMessages() {
+    }
+
+    public static List<String> forJoin(
+        GameState game,
+        PlayerState player,
+        Instant now
+    ) {
+        List<String> messages = new ArrayList<>();
+        messages.add("Game: " + game.lifecycle());
+        boolean hasRole = false;
+        if (game.tyrantId().filter(player.playerId()::equals).isPresent()) {
+            messages.add("Role: TYRANT. Level " + game.tyrantLevel() + ", choices "
+                + game.unspentChoices() + ", abilities " + game.purchases() + ".");
+            hasRole = true;
+        }
+        if (game.vigilanteId().filter(player.playerId()::equals).isPresent()) {
+            messages.add("Role: VIGILANTE.");
+            hasRole = true;
+        } else if (player.followerOf().isPresent()) {
+            messages.add("Role: FOLLOWER of " + player.followerOf().orElseThrow() + ".");
+            hasRole = true;
+        }
+        if (player.tyrantClass() != TyrantClass.NONE) {
+            messages.add(ClassAssignmentMessages.loginReminder(player));
+            hasRole = true;
+        }
+        player.cooldownEnds().entrySet().stream()
+            .sorted(java.util.Map.Entry.comparingByKey())
+            .forEach(entry -> {
+                long seconds = Math.max(
+                    0L, Duration.between(now, entry.getValue()).toSeconds()
+                );
+                messages.add("Cooldown: " + entry.getKey() + " " + seconds + "s remaining.");
+            });
+        if (player.optedOutUntil().isPresent()) {
+            messages.add("Participation: OPTED OUT. You may use /tyrant optin at "
+                + player.optedOutUntil().orElseThrow() + ".");
+        } else if (!hasRole) {
+            messages.add("You currently have no role or class. Use /tyrant optout "
+                + "if you do not want to participate.");
+        }
+        return List.copyOf(messages);
+    }
+}

src/main/java/games/dmg/spigottyrant/RelinquishmentResult.java

@@ -0,0 +1,7 @@
+package games.dmg.spigottyrant;
+
+public record RelinquishmentResult(
+    LifecycleState state,
+    RelinquishmentStatus status
+) {
+}

src/main/java/games/dmg/spigottyrant/RelinquishmentStatus.java

@@ -0,0 +1,7 @@
+package games.dmg.spigottyrant;
+
+public enum RelinquishmentStatus {
+    RELINQUISHED,
+    NO_CENTRAL_ROLE,
+    GAME_NOT_RUNNING
+}

src/main/java/games/dmg/spigottyrant/RoleCandidateSelector.java

@@ -30,7 +30,7 @@ public final class RoleCandidateSelector {
                     || player.lastLogin().orElseThrow().isBefore(cutoff)) {
                 continue;
             }
-            if (player.optedOutUntil().filter(deadline -> deadline.isAfter(now)).isPresent()) {
+            if (player.optedOutUntil().isPresent()) {
                 continue;
             }
             eligible.add(player.playerId());

src/main/java/games/dmg/spigottyrant/RoleMaintenanceService.java

@@ -195,8 +195,7 @@ public final class RoleMaintenanceService {
     }
 
     private static boolean eligibleAtConfirmation(PlayerState player, Instant now) {
-        return player != null
-            && player.optedOutUntil().filter(deadline -> deadline.isAfter(now)).isEmpty();
+        return player != null && player.optedOutUntil().isEmpty();
     }
 
     private static Map<UUID, PlayerState> clearFollowers(

src/main/java/games/dmg/spigottyrant/RoleRelinquishmentService.java

@@ -0,0 +1,51 @@
+package games.dmg.spigottyrant;
+
+import java.time.Instant;
+import java.util.Optional;
+import java.util.Set;
+import java.util.UUID;
+
+public final class RoleRelinquishmentService {
+    private final TyrantSuccessionService succession;
+    private final RoleMaintenanceService maintenance;
+
+    public RoleRelinquishmentService(
+        TyrantSuccessionService succession,
+        RoleMaintenanceService maintenance
+    ) {
+        this.succession = succession;
+        this.maintenance = maintenance;
+    }
+
+    public RelinquishmentResult relinquish(
+        PersistentState state,
+        UUID playerId,
+        Set<UUID> onlinePlayerIds,
+        Instant now
+    ) {
+        if (state.game().lifecycle() != GameLifecycle.RUNNING) {
+            return new RelinquishmentResult(
+                new LifecycleState(state.game(), state.players()),
+                RelinquishmentStatus.GAME_NOT_RUNNING
+            );
+        }
+        if (state.game().tyrantId().filter(playerId::equals).isPresent()) {
+            return new RelinquishmentResult(
+                succession.succeed(state, Optional.empty(), onlinePlayerIds, now),
+                RelinquishmentStatus.RELINQUISHED
+            );
+        }
+        if (state.game().vigilanteId().filter(playerId::equals).isPresent()) {
+            return new RelinquishmentResult(
+                maintenance.rerollVigilante(
+                    state, Optional.of(playerId), onlinePlayerIds, now
+                ),
+                RelinquishmentStatus.RELINQUISHED
+            );
+        }
+        return new RelinquishmentResult(
+            new LifecycleState(state.game(), state.players()),
+            RelinquishmentStatus.NO_CENTRAL_ROLE
+        );
+    }
+}

src/main/java/games/dmg/spigottyrant/SpigotTyrantPlugin.java

@@ -37,18 +37,36 @@ public final class SpigotTyrantPlugin extends JavaPlugin {
             settings.pendingSelectionTimeout(),
             random
         );
+        RoleMaintenanceService maintenance = new RoleMaintenanceService(
+            candidateSelector,
+            succession,
+            settings.roleInactivity(),
+            settings.candidateActivityWindow(),
+            settings.pendingSelectionTimeout(),
+            random
+        );
+        BukkitOnlinePlayerDirectory onlinePlayers = new BukkitOnlinePlayerDirectory();
         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()));
+            .setExecutor(new TyrantCommand(
+                stateManager,
+                new TyrantProgressionService(),
+                new ClassAssignmentService(),
+                onlinePlayers,
+                clock,
+                new ParticipationService(settings.optOutDuration()),
+                new RoleRelinquishmentService(succession, maintenance),
+                tyrantPresentation
+            ));
         Objects.requireNonNull(getCommand("tyrantadmin"), "Missing tyrantadmin metadata")
             .setExecutor(new TyrantAdminCommand(
                 stateManager,
                 new GameLifecycleService(),
-                new BukkitOnlinePlayerDirectory(),
+                onlinePlayers,
                 managedEffects,
                 clock,
                 candidateSelector,
@@ -66,14 +84,6 @@ public final class SpigotTyrantPlugin extends JavaPlugin {
             ),
             this
         );
-        RoleMaintenanceService maintenance = new RoleMaintenanceService(
-            candidateSelector,
-            succession,
-            settings.roleInactivity(),
-            settings.candidateActivityWindow(),
-            settings.pendingSelectionTimeout(),
-            random
-        );
         long maintenanceTicks = Math.max(
             1L, Math.multiplyExact(settings.selectionRetryInterval().toSeconds(), 20L)
         );

src/main/java/games/dmg/spigottyrant/TyrantAdminCommand.java

@@ -187,9 +187,7 @@ public final class TyrantAdminCommand implements CommandExecutor {
         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();
+            boolean optedOut = player.optedOutUntil().isPresent();
             sender.sendMessage(
                 player.latestName() + " (" + player.playerId() + "): class="
                     + player.tyrantClass() + ", followerOf="

src/main/java/games/dmg/spigottyrant/TyrantCommand.java

@@ -1,6 +1,7 @@
 package games.dmg.spigottyrant;
 
 import java.time.Clock;
+import java.time.Duration;
 import java.util.Locale;
 import org.bukkit.ChatColor;
 import org.bukkit.command.Command;
@@ -14,6 +15,9 @@ public final class TyrantCommand implements CommandExecutor {
     private final ClassAssignmentService assignments;
     private final OnlinePlayerDirectory onlinePlayers;
     private final Clock clock;
+    private final ParticipationService participation;
+    private final RoleRelinquishmentService relinquishment;
+    private final TyrantPresentation presentation;
 
     public TyrantCommand(
         TyrantStateManager stateManager,
@@ -34,12 +38,31 @@ public final class TyrantCommand implements CommandExecutor {
         ClassAssignmentService assignments,
         OnlinePlayerDirectory onlinePlayers,
         Clock clock
+    ) {
+        this(
+            stateManager, progression, assignments, onlinePlayers, clock,
+            new ParticipationService(Duration.ofDays(7)), null, null
+        );
+    }
+
+    public TyrantCommand(
+        TyrantStateManager stateManager,
+        TyrantProgressionService progression,
+        ClassAssignmentService assignments,
+        OnlinePlayerDirectory onlinePlayers,
+        Clock clock,
+        ParticipationService participation,
+        RoleRelinquishmentService relinquishment,
+        TyrantPresentation presentation
     ) {
         this.stateManager = stateManager;
         this.progression = progression;
         this.assignments = assignments;
         this.onlinePlayers = onlinePlayers;
         this.clock = clock;
+        this.participation = participation;
+        this.relinquishment = relinquishment;
+        this.presentation = presentation;
     }
 
     @Override
@@ -65,10 +88,26 @@ public final class TyrantCommand implements CommandExecutor {
             assign(player, arguments[1], arguments[2]);
             return true;
         }
+        if (arguments.length == 1 && arguments[0].equalsIgnoreCase("status")) {
+            showPlayerStatus(player);
+            return true;
+        }
+        if (arguments.length == 1 && arguments[0].equalsIgnoreCase("optout")) {
+            changeParticipation(player, false);
+            return true;
+        }
+        if (arguments.length == 1 && arguments[0].equalsIgnoreCase("optin")) {
+            changeParticipation(player, true);
+            return true;
+        }
+        if (arguments.length >= 1 && arguments[0].equalsIgnoreCase("relinquish")) {
+            relinquish(player, arguments);
+            return true;
+        }
         player.sendMessage(
             ChatColor.YELLOW
-                + "Usage: /tyrant choices | /tyrant buy <unlock> | "
-                + "/tyrant assign <class> <player>"
+                + "Usage: /tyrant <status|choices|buy|assign|optout|optin|"
+                + "relinquish confirm>"
         );
         return true;
     }
@@ -156,6 +195,63 @@ public final class TyrantCommand implements CommandExecutor {
         );
     }
 
+    private void showPlayerStatus(Player player) {
+        PlayerState state = stateManager.player(player.getUniqueId(), player.getName());
+        PlayerStatusMessages.forJoin(stateManager.game(), state, clock.instant())
+            .forEach(player::sendMessage);
+    }
+
+    private void changeParticipation(Player player, boolean optIn) {
+        ParticipationResult[] result = new ParticipationResult[1];
+        stateManager.updatePlayer(player.getUniqueId(), player.getName(), current -> {
+            result[0] = optIn
+                ? participation.optIn(current, clock.instant())
+                : participation.optOut(stateManager.game(), current, clock.instant());
+            return result[0].player();
+        });
+        if (result[0].status() == ParticipationStatus.OPTED_IN
+                || result[0].status() == ParticipationStatus.OPTED_OUT) {
+            stateManager.saveIfDirty();
+        }
+        if (result[0].status() == ParticipationStatus.MUST_RELINQUISH_ROLE) {
+            player.sendMessage(ChatColor.RED
+                + "Use /tyrant relinquish confirm before opting out.");
+            return;
+        }
+        if (result[0].status() == ParticipationStatus.COOLDOWN_ACTIVE) {
+            player.sendMessage(ChatColor.RED + "You may opt in at "
+                + result[0].player().optedOutUntil().orElseThrow() + ".");
+            return;
+        }
+        player.sendMessage(ChatColor.YELLOW + "Participation: "
+            + readable(result[0].status()) + ".");
+    }
+
+    private void relinquish(Player player, String[] arguments) {
+        if (arguments.length != 2 || !arguments[1].equalsIgnoreCase("confirm")) {
+            player.sendMessage(ChatColor.RED
+                + "Relinquishing rerolls your role. Use /tyrant relinquish confirm.");
+            return;
+        }
+        if (relinquishment == null) {
+            player.sendMessage(ChatColor.RED + "Role relinquishment is unavailable.");
+            return;
+        }
+        RelinquishmentResult result = relinquishment.relinquish(
+            stateManager.snapshot(), player.getUniqueId(), onlinePlayers.onlinePlayerIds(),
+            clock.instant()
+        );
+        if (result.status() == RelinquishmentStatus.RELINQUISHED) {
+            stateManager.replaceState(result.state());
+            stateManager.saveIfDirty();
+            if (presentation != null) {
+                presentation.reconcile(result.state().game().tyrantId());
+            }
+        }
+        player.sendMessage(ChatColor.YELLOW + "Relinquishment: "
+            + readable(result.status()) + ".");
+    }
+
     private static String readable(Enum<?> status) {
         return status.name().toLowerCase(Locale.ROOT).replace('_', ' ');
     }