Final tweaks, remove debug broadcast and add docs

docs/events.md

@@ -9,6 +9,242 @@ You can easily connect to the event stream from your terminal using
 curl -H "Accept:text/event-steam" "https://api.earthmc.net/v3/aurora/events"
 ````
 
+<br>
+
+### Here is a list of all the events and their JSON structure:
+*(Each event carries a UNIX timestamp)*
+
+- PlayerJoin (aurora)
+```yaml
+{
+  player: {
+    name: str
+    uuid: str
+  }
+}
+```
+- PlayerQuit (aurora)
+```yaml
+{
+  player: {
+    name: str
+    uuid: str
+  }
+}
+```
+
+<br>
+
+- NewDay
+```yaml
+{
+  fallenTowns: str[]
+  fallenNations: str[]
+}
+```
+
+<br>
+
+- NewNation
+```yaml
+{
+  nation: {
+    name: str
+    uuid: str
+  }
+  king: {
+    name: str
+    uuid: str
+  }
+}
+```
+- DeleteNation
+```yaml
+{
+  nation: {
+    name: str
+    uuid: str
+  }
+  king: {
+    name: str
+    uuid: str
+  }
+}
+```
+- RenameNation
+```yaml
+{
+  nation: {
+    name: str
+    uuid: str
+  }
+  oldName: str
+}
+```
+- NationKingChange
+```yaml
+{
+  nation: {
+    name: str
+    uuid: str
+  }
+  newKing: {
+    name: str
+    uuid: str
+  }
+  oldKing: {
+    name: str
+    uuid: str
+  }
+  isCapitalChange: bool
+
+  # if isCapitalChange is true:
+  newCapital: {
+    name: str
+    uuid: str
+  }
+  oldCapital: {
+    name: str
+    uuid: str
+  }
+}
+```
+- NationAddTown
+```yaml
+{
+  nation: {
+    name: str
+    uuid: str
+  }
+  town: {
+    name: str
+    uuid: str
+  }
+}
+```
+- NationRemoveTown
+```yaml
+{
+  nation: {
+    name: str
+    uuid: str
+  }
+  town: {
+    name: str
+    uuid: str
+  }
+}
+```
+
+<br>
+
+- NewTown
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  mayor: {
+    name: str
+    uuid: str
+  }
+}
+```
+- DeleteTown
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  mayor: {
+    name: str
+    uuid: str
+  }
+}
+```
+- RenameTown
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  oldName: str
+}
+```
+- TownMayorChanged
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  newMayor: {
+    name: str
+    uuid: str
+  }
+  oldMayor: {
+    name: str
+    uuid: str
+  }
+}
+```
+- TownRuined
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  oldMayor: {
+    name: str
+    uuid: str
+  }
+}
+```
+- TownReclaimed
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  newMayor: {
+    name: str
+    uuid: str
+  }
+}
+```
+- TownAddResident
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  resident: {
+    name: str
+    uuid: str
+  }
+}
+```
+- TownRemoveResident
+```yaml
+{
+  town: {
+    name: str
+    uuid: str
+  }
+  resident: {
+    name: str
+    uuid: str
+  }
+}
+```
+
+<br>
 
 Example `NewNation` event
 ```json5

src/main/java/net/earthmc/emcapi/EMCAPI.java

@@ -51,12 +51,10 @@ public void onEnable() {
 
         getServer().getPluginManager().registerEvents(new TownyListeners(), this);
         getServer().getPluginManager().registerEvents(new PlayerConnectionListener(), this);
-
     }
 
     @Override
     public void onDisable() {
-        //sseManager.stop();    Should I add this or is it enough to simply shut down javalin?
         javalin.stop();
     }
 

src/main/java/net/earthmc/emcapi/listeners/TownyListeners.java

@@ -55,6 +55,10 @@ public void onNationKingChange(NationKingChangeEvent event) {
         message.add("newKing", EndpointUtils.getResidentJsonObject(event.getNewKing()));
         message.add("oldKing", EndpointUtils.getResidentJsonObject(event.getOldKing()));
         message.addProperty("isCapitalChange", event.isCapitalChange());
+        if (event.isCapitalChange()) {
+            message.add("newCapital", EndpointUtils.getTownJsonObject(event.getNewKing().getTownOrNull()));
+            message.add("oldCapital", EndpointUtils.getTownJsonObject(event.getOldKing().getTownOrNull()));
+        }
         SSEManager.broadcastMessage("NationKingChange", message);
     }
 
@@ -110,10 +114,10 @@ public void onTownMayorChanged(TownMayorChangedEvent event) {
     }
 
     @EventHandler
-    public void onTownRuined(TownRuinedEvent event) {
+    public void onTownRuined(TownPreRuinedEvent event) {
         JsonObject message = new JsonObject();
         message.add("town", EndpointUtils.getTownJsonObject(event.getTown()));
-        message.addProperty("oldMayor", event.getOldMayorName());
+        message.add("oldMayor", EndpointUtils.getResidentJsonObject(event.getTown().getMayor()));
         SSEManager.broadcastMessage("TownRuined", message);
     }
 

src/main/java/net/earthmc/emcapi/manager/SSEManager.java

@@ -24,15 +24,6 @@ public void loadSSE() {
             client.onClose(() -> clients.remove(client));
             clients.add(client);
         });
-
-        // Testing purposes
-        javalin.get("/broadcast", ctx -> {
-            JsonObject message = new JsonObject();
-            message.addProperty("text", "Hello to all connected clients!");
-            broadcastMessage("Hello", message);
-            ctx.result("Message broadcasted to all %s clients".formatted(clients.size()));
-        });
-        // Testing purposes
     }
 
     public static void broadcastMessage(String event, JsonObject data) {