refactor(player): move generic code to sdk

Author: xeruf

player/src/main/sc/player2021/Starter.java

@@ -4,8 +4,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sc.player2021.logic.Logic;
-import sc.plugin2021.PlayerClient;
-import sc.plugin2021.IGameHandler;
+import sc.player.PlayerClient;
+import sc.player.IGameHandler;
 import sc.shared.SharedConfiguration;
 
 import java.io.File;
@@ -20,9 +20,9 @@ public class Starter {
   public Starter(String host, int port, String reservation) {
     // Strategie zuweisen
     IGameHandler logic = new Logic();
+    PlayerClient client = new PlayerClient(host, port, logic);
 
     // einem Spiel beitreten
-    PlayerClient client = new PlayerClient(host, port, logic);
     if (reservation == null || reservation.isEmpty()) {
       client.joinAnyGame();
     } else {
@@ -33,22 +33,22 @@ public Starter(String host, int port, String reservation) {
   public static void main(String[] args) {
     System.setProperty("file.encoding", "UTF-8");
 
-    // parameter definieren
+    // Parameter definieren
     CmdLineParser parser = new CmdLineParser();
     CmdLineParser.Option hostOption = parser.addStringOption('h', "host");
     CmdLineParser.Option portOption = parser.addIntegerOption('p', "port");
     CmdLineParser.Option reservationOption = parser.addStringOption('r', "reservation");
 
     try {
-      // parameter auslesen
+      // Parameter auslesen
       parser.parse(args);
     } catch (CmdLineParser.OptionException e) {
-      // bei Fehler die Hilfe anzeigen
+      // bei einem Fehler die Hilfe anzeigen
       showHelp(e.getMessage());
       System.exit(2);
     }
 
-    // parameter laden
+    // Parameter laden
     String host = (String) parser.getOptionValue(hostOption, "localhost");
     int port = (Integer) parser.getOptionValue(portOption, SharedConfiguration.DEFAULT_PORT);
     String reservation = (String) parser.getOptionValue(reservationOption, "");

player/src/main/sc/player2021/logic/Logic.java

@@ -2,7 +2,9 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import sc.api.plugins.TwoPlayerGameState;
 import sc.framework.plugins.Player;
+import sc.player.IGameHandler;
 import sc.plugin2021.*;
 import sc.plugin2021.util.GameRuleLogic;
 import sc.shared.GameResult;
@@ -25,8 +27,8 @@ public class Logic implements IGameHandler {
   /** Aktueller eigener Spieler. */
   private Player currentPlayer;
 
-  public void gameEnded(GameResult data, Team color, String errorMessage) {
-    log.info("Das Spiel ist beendet.");
+  public void gameEnded(GameResult data, String errorMessage) {
+    log.info("Das Spiel ist beendet, Ergebnis: {}", data);
   }
 
   @Override
@@ -43,8 +45,8 @@ public void onUpdate(Player player, Player otherPlayer) {
   }
 
   @Override
-  public void onUpdate(GameState gameState) {
-    this.gameState = gameState;
+  public void onUpdate(TwoPlayerGameState<?> gameState) {
+    this.gameState = (GameState) gameState;
     log.info("Zug: {} Dran: {}", gameState.getTurn(), gameState.getCurrentPlayer().getColor());
   }
 

sdk/build.gradle.kts

@@ -1,5 +1,5 @@
 sourceSets {
-    main.get().java.setSrcDirs(listOf("src/framework", "src/server-api"))
+    main.get().java.setSrcDirs(listOf("src/framework", "src/server-api", "src/player"))
     test.get().java.setSrcDirs(listOf("src/test"))
     create("testConfig") {
         java.setSrcDirs(listOf("src/testConfig"))

plugin/src/client/sc/plugin2021/IGameHandler.kt renamed to sdk/src/player/sc/player/IGameHandler.kt

@@ -1,8 +1,9 @@
-package sc.plugin2021
+package sc.player
 
+import sc.api.plugins.IMove
+import sc.api.plugins.TwoPlayerGameState
 import sc.framework.plugins.Player
 import sc.shared.GameResult
-import sc.api.plugins.ITeam
 
 /**
  * Das Interface der Logik.
@@ -20,20 +21,19 @@ interface IGameHandler {
     fun onUpdate(player: Player, otherPlayer: Player)
 
     /** Wird aufgerufen, wenn sich das Spielbrett ändert. */
-    fun onUpdate(gamestate: GameState)
+    fun onUpdate(gamestate: TwoPlayerGameState<*>)
 
     /**
      * Wird aufgerufen, um die Zuganfrage des Servers zu beantworten
      */
-    fun calculateMove(): Move
+    fun calculateMove(): IMove
 
     /**
      * Wird aufgerufen, wenn das Spiel beendet ist.
      *
      * @param data         Das Spielergebnis
-     * @param team         Team des Spielers
      * @param errorMessage Optionale Fehlernachricht
      */
-    fun gameEnded(data: GameResult, team: Team?, errorMessage: String?)
+    fun gameEnded(data: GameResult, errorMessage: String?)
 
 }

plugin/src/client/sc/plugin2021/PlayerClient.kt renamed to sdk/src/player/sc/player/PlayerClient.kt

@@ -1,7 +1,7 @@
-package sc.plugin2021
+package sc.player
 
 import org.slf4j.LoggerFactory
-import sc.api.plugins.IGameState
+import sc.api.plugins.*
 import sc.framework.plugins.protocol.MoveRequest
 import sc.networking.clients.AbstractLobbyClientListener
 import sc.networking.clients.IControllableGame
@@ -13,6 +13,7 @@ import sc.protocol.responses.ProtocolMessage
 import sc.shared.GameResult
 import sc.shared.WelcomeMessage
 import java.net.ConnectException
+import java.util.ServiceLoader
 import kotlin.system.exitProcess
 
 /**
@@ -22,7 +23,7 @@ import kotlin.system.exitProcess
 class PlayerClient(
         host: String,
         port: Int,
-        private val handler: IGameHandler
+        private val handler: IGameHandler,
 ): AbstractLobbyClientListener() {
     companion object {
         private val logger = LoggerFactory.getLogger(PlayerClient::class.java)
@@ -46,24 +47,20 @@ class PlayerClient(
     private lateinit var roomId: String
 
     /** The team the client belongs to. Needed to connect client and player. */
-    var team: Team? = null
+    var teamName: String? = null
         private set
 
-    /** Tell this client to observe the game given by the preparation handler. */
-    fun observeGame(handle: GamePreparedResponse): IControllableGame =
-            client.observe(handle.roomId)
-    
     /** Called for any new message sent to the game room, e.g., move requests. */
     override fun onRoomMessage(roomId: String, data: ProtocolMessage) {
         this.roomId = roomId
-        when(data) {
+        when (data) {
             is MoveRequest -> sendMove(handler.calculateMove())
-            is WelcomeMessage -> team = Team.valueOf(data.color.toUpperCase())
+            is WelcomeMessage -> teamName = data.color
         }
     }
 
     /** Sends the selected move to the server. */
-    fun sendMove(move: Move) =
+    fun sendMove(move: IMove) =
             client.sendMessageToRoom(roomId, move)
 
     /** Called when an erroneous message is sent to the room. */
@@ -77,18 +74,17 @@ class PlayerClient(
      * Happens after a client made a move.
      */
     override fun onNewState(roomId: String, state: IGameState) {
-        val gameState = state as GameState
+        val gameState = state as TwoPlayerGameState<*>
         logger.debug("$this got a new state $gameState")
-    
-        if (team == null || !gameState.hasValidColors())
-            return
-    
-        if (gameState.currentTeam == team) {
-            handler.onUpdate(gameState.currentPlayer, gameState.otherPlayer)
-        } else {
-            handler.onUpdate(gameState.otherPlayer, gameState.currentPlayer)
+        
+        teamName?.let { teamName ->
+            if (gameState.currentTeam.name == teamName) {
+                handler.onUpdate(gameState.currentPlayer, gameState.otherPlayer)
+            } else {
+                handler.onUpdate(gameState.otherPlayer, gameState.currentPlayer)
+            }
+            handler.onUpdate(gameState)
         }
-        handler.onUpdate(gameState)
     }
 
     /** Start the LobbyClient [client] and listen to it. */
@@ -100,7 +96,7 @@ class PlayerClient(
     /** [start] and join any game with the appropriate [gameType]. */
     fun joinAnyGame() {
         start()
-        client.joinRoomRequest(GamePlugin.PLUGIN_ID)
+        client.joinRoomRequest(IGamePlugin.loadPluginId())
     }
 
     override fun onGameLeft(roomId: String) {
@@ -111,7 +107,7 @@ class PlayerClient(
     override fun onGameOver(roomId: String, data: GameResult) {
         logger.info("$this: Game over with result $data")
         isGameOver = true
-        handler.gameEnded(data, team, error)
+        handler.gameEnded(data, error)
     }
 
     fun joinPreparedGame(reservation: String) {