| name | create-module |
| description | ArenaModule interface (api/) — arena-composition contract per ADR-0008. ModuleCatalog, ModuleLoader, and ArenaModuleSystem are live. Author new ArenaModule classes under infinity-server/src/main/java/infinity/modules/<category>/ and register them in ModuleCatalog. |
Creating Arena Modules
ADR-0008 defines the arena-composition model: per-arena ArenaModule instances composing scoring, win-condition, mechanics, team-setup, roster, respawn, round/match structure, spawn-placement, and shop into named gametypes. The runtime is wired: ArenaModule interface in api/src/main/java/infinity/sim/, category sub-interfaces in api/src/main/java/infinity/modules/, ModuleCatalog + ModuleLoader + ArenaModuleSystem in infinity-server/src/main/java/infinity/modules/.
How to add a new module
- Pick the category. One of
ScoringModule, WinConditionModule, MechanicModule, TeamSetupModule, RosterModule, RespawnPolicyModule, RoundStructureModule, MatchStructureModule, SpawnPlacementModule, ShopModule (all in api/src/main/java/infinity/modules/).
- Author the class under
infinity-server/src/main/java/infinity/modules/<category>/<Name>.java. Implement the category interface. Constructor signature: public MyModule(final ModuleContext ctx, final MyConfig config) — or (final ModuleContext ctx) for zero-config modules.
- Add a
*Config record under api/src/main/java/infinity/config/ if the module accepts kwargs. Jackson ObjectMapper.convertValue binds the arena.groovy kwargs map into the record.
- Register in
ModuleCatalog (infinity-server/src/main/java/infinity/modules/ModuleCatalog.java): add a ModuleDescriptor(MyModule.class, MyConfig.class, ModuleCategory.X, Set.of()) entry under a short DSL id.
- Reference from
arena.groovy with the matching DSL statement (scoring 'my-id', kw: v for scoring, etc.).
Canonical examples to mimic: AllShipsRoster (zero-config marker), KillPointsScoring (subscribes to EventBus, emits *Change transients), TimedRoundStructure (per-tick state machine), FirstToXWinCondition (dual-role terminator + decider), RandomRadiusSpawnPlacement (kwargs binding with conditional shape — single center or per-freq centers map), FfaPrivateFreqsTeamSetup (zero-config TeamSetupModule — EntitySet-based claim/release + per-tick team-entity lifecycle), TwoFixedTeamsTeamSetup (eager 2-team creation at onArenaLoad, balanced joins via tickTeamSetup), FlagHoldTimeScoring (per-tick ScoringModule using tickContributions — emits TeamScoreChange per owned flag per tick), MostFlagOccupancyWinCondition (decider-only — reads TeamFlagHoldTicks per team at round-end), Crowns (opt-in mechanic — canonical writer of CrownHolder; distributes at onRoundStart, transfers on kill, clears at onRoundEnd), LastCrownStandingWinCondition (two-role: terminator caches winner when crown set shrinks to 1; decider returns cached freq, sticky until onRoundStart re-arms), CrownKillBonus (additive scoring layer — emits PlayerScoreChange on attributed kill scaled by killer's crown count; reads CrownHolder, never writes it), LockoutNoCrownRespawn (respawn policy — gates respawn queue on EntitySet(CrownHolder, ArenaId) having ≥1 holder; force-drains on onRoundEnd), CrownResetRoundStructure (timed terminator variant — emits RoundEndPending on timer; delivers KOTH-themed countdown chat via postArenaMessage).
The catalog now contains 22 modules (16 after F4, +6 in F5: crowns, last-crown-standing, most-crowns, crown-kill-bonus, lockout-no-crown-respawn, crown-reset). ArenaModuleContractTest walks all 22.
Module lifecycle hooks
Every module inherits these from ArenaModule:
default void onArenaLoad(ArenaId arenaId) {}
default void onMatchStart(ArenaId arenaId) {}
default void onRoundStart(ArenaId arenaId, int roundNumber) {}
default void onRoundEnd(ArenaId arenaId, int roundNumber, RoundOutcome o) {}
default void onMatchEnd(ArenaId arenaId, MatchOutcome o) {}
default void onArenaUnload(ArenaId arenaId) {}
Category-specific per-tick hooks
Some categories add a per-tick dispatcher beyond the base lifecycle. ArenaModuleSystem.update calls these on every loaded impl each server tick (default no-op when not overridden):
TeamSetupModule.tickTeamSetup(ArenaId, SimTime) — observe ship arrivals/departures, maintain team entities.MechanicModule.tickMechanic(ArenaId, SimTime) — opt-in mechanics' state-publishing phase.ScoringModule.tickContributions(ArenaId, SimTime) — per-tick scoring contribution; first impl is FlagHoldTimeScoring. Event-driven scorers (KillPointsScoring, BonusPointsScoring) inherit the default no-op.RoundStructureModule.tickRoundStructure(ArenaId, SimTime) — terminator state machine.WinConditionModule.checkTermination(ArenaId) — per-tick query (not a void hook).
Implement only the hook(s) you need; the base lifecycle covers the rest.
Cleanup contract (ADR-0008-β): onArenaUnload MUST remove every component / entity / EventBus listener / Decay token the module added during the arena's lifetime. Verified by ArenaModuleContractTest (parameterised over ModuleCatalog.allDescriptors()); a leaking module shows up as a non-zero entity-count delta across the lifecycle.
Hot-reload (F3): ArenaFileWatcherSystem polls each arena's arena.groovy and on a module-set diff calls ArenaModuleSystem.applyModuleSetDiff — removed modules get onArenaUnload, added modules get onArenaLoad + onMatchStart + onRoundStart(currentRound). Unchanged modules keep their instance state. Reconfigured kwargs are currently treated as remove+add; opt into the Reloadable<C> companion interface if your module can apply config changes in place.
Module Philosophy
- Modules are the building blocks for extending server functionality.
- Similar to ASSS modules but data-oriented instead of object-oriented.
- Networking is abstracted by SimEthereal — modules write components on the ECS; clients observe via Zay-ES sync.
- Modules emit intents (
*Change transient entities); canonical writer systems drain them per ADR-0001. Never write components owned by another system.
