Merge pull request #200 from Mind-Sports-Games/pla-1039-add-hyper-backgammon-variant

add new variant hyper backgammon

Author: JamesHeppell

build.sbt

@@ -2,7 +2,7 @@ name := "strategygames"
 
 organization := "org.playstrategy"
 
-version := "10.2.1-pstrat162"
+version := "10.2.1-pstrat163"
 
 scalaVersion := "2.13.10"
 

src/main/scala/backgammon/variant/Hyper.scala

@@ -0,0 +1,32 @@
+package strategygames.backgammon
+package variant
+
+import strategygames.backgammon._
+import strategygames.GameFamily
+
+case object Hyper
+    extends Variant(
+      id = 4,
+      key = "hyper",
+      name = "Hyper",
+      standardInitialPosition = false,
+      boardSize = Board.Dim12x2
+    ) {
+
+  def gameFamily: GameFamily = GameFamily.Backgammon()
+
+  def perfIcon: Char = ''
+  def perfId: Int    = 602
+
+  override def numStartingPiecesPerPlayer: Int = 3
+
+  // gammon and backgammon only count when the cube has been doubled in this variant
+  override def gammonWin(situation: Situation)     = false
+  override def backgammonWin(situation: Situation) = false
+
+  override def baseVariant: Boolean = false
+
+  override def initialFen =
+    format.FEN("9,1S,1S,1S/9,1s,1s,1s[] - - w 0 0 1")
+
+}

src/main/scala/backgammon/variant/Variant.scala

@@ -48,6 +48,8 @@ abstract class Variant private[variant] (
 
   def startPlayer: Player = P1
 
+  def numStartingPiecesPerPlayer: Int = 15
+
   // returns the updated piecemap for pieces on the board and an optional captured piece to put in the pocket
   private def piecesAfterAction(
       pieces: PieceMap,
@@ -479,8 +481,8 @@ abstract class Variant private[variant] (
     else None
 
   def specialEnd(situation: Situation) =
-    (situation.board.history.score.p1 == 15) ||
-      (situation.board.history.score.p2 == 15)
+    (situation.board.history.score.p1 == numStartingPiecesPerPlayer) ||
+      (situation.board.history.score.p2 == numStartingPiecesPerPlayer)
 
   def gammonPosition(situation: Situation, player: Player) =
     situation.board.history.score(player) == 0 &&
@@ -489,8 +491,8 @@ abstract class Variant private[variant] (
 
   // doesnt check for not a backgammonWin
   def gammonWin(situation: Situation) =
-    (situation.board.history.score.p1 == 15 && situation.board.history.score.p2 == 0) ||
-      (situation.board.history.score.p2 == 15 && situation.board.history.score.p1 == 0)
+    (situation.board.history.score.p1 == numStartingPiecesPerPlayer && situation.board.history.score.p2 == 0) ||
+      (situation.board.history.score.p2 == numStartingPiecesPerPlayer && situation.board.history.score.p1 == 0)
 
   def backgammonPosition(situation: Situation, player: Player) =
     situation.board.history.score(player) == 0 &&
@@ -499,12 +501,12 @@ abstract class Variant private[variant] (
 
   def backgammonWin(situation: Situation) =
     (
-      situation.board.history.score.p1 == 15 &&
+      situation.board.history.score.p1 == numStartingPiecesPerPlayer &&
         situation.board.history.score.p2 == 0 && (
           situation.board.piecesOnBar(P2) || situation.board.pieceInOpponentsHome(P2)
         )
     ) || (
-      situation.board.history.score.p2 == 15 &&
+      situation.board.history.score.p2 == numStartingPiecesPerPlayer &&
         situation.board.history.score.p1 == 0 && (
           situation.board.piecesOnBar(P1) || situation.board.pieceInOpponentsHome(P1)
         )
@@ -521,8 +523,8 @@ abstract class Variant private[variant] (
   def materialImbalance(board: Board): Int = board.history.score.p2 - board.history.score.p1
 
   def valid(board: Board, @nowarn strict: Boolean): Boolean =
-    board.playerPiecesOnBoardOrInPocket(P1) + board.history.score.p1 == 15 &&
-      board.playerPiecesOnBoardOrInPocket(P2) + board.history.score.p2 == 15
+    board.playerPiecesOnBoardOrInPocket(P1) + board.history.score.p1 == numStartingPiecesPerPlayer &&
+      board.playerPiecesOnBoardOrInPocket(P2) + board.history.score.p2 == numStartingPiecesPerPlayer
 
   val roles: List[Role] = Role.all
 
@@ -549,7 +551,8 @@ object Variant {
 
   lazy val all: List[Variant] = List(
     Backgammon,
-    Nackgammon
+    Nackgammon,
+    Hyper
   )
   val byId                    = all map { v =>
     (v.id, v)

src/test/scala/backgammon/BackgammonVariantTest.scala

@@ -4988,8 +4988,73 @@ class BackgammonVariantTest extends BackgammonTest with ValidatedMatchers {
         g.situation.forcedAction.isEmpty must_== true
       }
     }
+  }
+
+  "A Hyper Backgammon game " should {
+    "have 3 moves from start" in {
+      val actionStrs = List(
+        "4/2",
+        "l1h1"
+      )
+      playActionStrs(actionStrs, Some(Game.apply(variant.Hyper))) must beValid.like { g =>
+        g.situation.moves.values.flatten.map(_.toUci.uci).toSet must_== Set("h1f1", "j1h1", "k1i1")
+      }
+    }
 
+    "end in single win even if in backgammon position" in {
+      val actionStrs = List(
+        "endturn",
+        "6/2",
+        "l1j1",
+        "k1e1",
+        "endturn",
+        "3/1",
+        "l2i2",
+        "j2i2",
+        "endturn",
+        "4/4",
+        "j1f1",
+        "f1b1",
+        "b1c2",
+        "c2g2",
+        "endturn",
+        "6/4",
+        "k2e2",
+        "e2a2",
+        "endturn",
+        "6/6",
+        "e1b2",
+        "b2h2",
+        "j1d1",
+        "d1c2",
+        "endturn",
+        "2/1",
+        "a2a1",
+        "a1c1",
+        "endturn",
+        "5/5",
+        "c2h2",
+        "g2l2",
+        "^h2",
+        "^h2",
+        "endturn",
+        "2/1",
+        "c1d1",
+        "d1f1",
+        "endturn",
+        "1/2",
+        "^l2"
+      )
+      playActionStrs(actionStrs, Some(Game.apply(variant.Hyper))) must beValid.like { g =>
+        g.situation.board.history.score must_== Score(0, 3)
+        g.situation.end must_== true
+        g.situation.board.pieceInOpponentsHome(Player.P1) must_== true
+        g.situation.winner must_== Some(Player.P2)
+        g.situation.status must_== Some(Status.SingleWin) // not a backgammon due to no double of cube
+      }
+    }
   }
+
 }
 
 class BackgammonVariantTestIsometry extends strategygames.chess.ChessTest {