https://github.com/lamaabdeldayem/peg-reversal-game
A Haskell board game where the goal is to flip all black pegs to white, demonstrating recursion and immutability.
https://github.com/lamaabdeldayem/peg-reversal-game
board-game functional-programming haskell immutability recursion
Last synced: about 1 month ago
JSON representation
A Haskell board game where the goal is to flip all black pegs to white, demonstrating recursion and immutability.
- Host: GitHub
- URL: https://github.com/lamaabdeldayem/peg-reversal-game
- Owner: lamaabdeldayem
- Created: 2024-09-17T10:36:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-01-17T13:04:53.000Z (4 months ago)
- Last Synced: 2025-02-01T18:16:42.949Z (3 months ago)
- Topics: board-game, functional-programming, haskell, immutability, recursion
- Language: Haskell
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎲 Haskell Board Game Implementation 🧩
## 🚀 Overview
Welcome to the **Haskell Board Game Implementation**! In this game, the objective is simple: turn all black pegs (`B`) into white pegs (`W`). The twist? You can only flip pegs adjacent to white ones. This project showcases key **functional programming** concepts like **recursion**, **immutability**, and more. Let's dive into the board and start flipping those pegs! 🔄
### 🎯 Core Concepts
- **Position**: Coordinates of a peg on the board.
- **Color**: A peg's color, either white (`W`) or black (`B`).
- **Peg**: Combines a position and a color.
- **Move**: A move targeting a specific position.
- **Board**: A list of all pegs on the board.
- **State**: Represents the current move and board configuration.
---
## 📊 Data Types
### Definitions
```haskell
type Position = (Int, Int)
data Color = W | B deriving (Eq, Show)
data Peg = Peg Position Color deriving (Eq, Show)
data Move = M Position deriving (Eq, Show)
type Board = [Peg]
data State = S Move Board deriving (Eq, Show)
```
### 📝 Explanation
- **Position**: A tuple `(Int, Int)` representing the x and y coordinates.
- **Color**: An enumeration with two values: `W` (White) and `B` (Black).
- **Peg**: A peg located at a certain position with a specific color.
- **Move**: Represents a move to a targeted position on the board.
- **Board**: A collection of all pegs.
- **State**: A snapshot of the current game, including the move and board state.
---
## 🛠️ Functions
### 1. `createBoard`
Creates the initial board configuration based on a given starting position.
```haskell
createBoard :: Position -> Board
createBoard (a, b)
| abs a + abs b > 4 || (abs a == 2 && abs b == 2) = error "Program error: The position is not valid."
| otherwise = [
Peg (x, y) (
\(u, v) (i, r) -> if (u, v) == (i, r) then W else B
) (a, b) (x, y)
| x <- [-3..3], y <- [-3..3], abs x + abs y <= 4, (abs x /= 2 || abs y /= 2)
]
```
**📝 Details**:
- Generates a list of pegs for the board.
- Excludes invalid positions (e.g., outside the playable area).
### 2. `isValidMove`
Checks if a move is valid based on the current board.
```haskell
isValidMove :: Move -> Board -> Bool
isValidMove (M (x, y)) b
| elem (Peg (x, y) W) b = False
| elem (Peg (x + 1, y) W) b || elem (Peg (x, y + 1) W) b || elem (Peg (x - 1, y) W) b || elem (Peg (x, y - 1) W) b = True
| otherwise = False
```
**📝 Details**:
- A move is valid if it targets a black peg adjacent to at least one white peg.
### 3. `isGoal`
Checks if the board has reached the goal state (all pegs are white).
```haskell
isGoal :: Board -> Bool
isGoal b = notElem False [c == W | (Peg (_, _) c) <- b]
```
**📝 Details**:
- Returns `True` if all pegs on the board are white.
### 4. `showPossibleNextStates`
Generates all possible next states from the current board.
```haskell
showPossibleNextStates :: Board -> [State]
showPossibleNextStates b
| isGoal b = error "Program error: No Possible States Exist."
| otherwise = [
S (M (x, y)) (
map
(\(Peg (c, d) m) -> if (x, y) == (c, d) then Peg (c, d) W else Peg (c, d) m)
b
)
| x <- [-3..3], y <- [-3..3], abs x + abs y <= 4, (abs x /= 2 || abs y /= 2), isValidMove (M (x, y)) b
]
```
**📝 Details**:
- Generates states by applying valid moves, flipping the target peg to white.
---
## 💻 How to Run
1. **Install Haskell (GHC)** on your system.
2. **Save the Code** to a file, e.g., `BoardGame.hs`.
3. **Load the File** in GHCi using:
```bash
ghci BoardGame.hs
```
4. **Play the Game** using the provided functions.
---
## 🎮 Example Usage
```haskell
-- Create a board with the initial white peg at position (0,0)
let board = createBoard (0, 0)
-- Check if a move is valid
isValidMove (M (1, 0)) board
-- Display all possible next states
showPossibleNextStates board
```
---
## ⚠️ Notes
- The board is modeled as a diamond shape with specific constraints on valid positions.
- This implementation assumes a fixed board size and predefined rules for valid moves.
---
## 🌱 Future Improvements
- Add a **graphical interface** to visually represent the board. 🖼️
- Implement **AI** to suggest optimal moves. 🤖
- Expand the rules to support additional game mechanics. 🎮
---
Enjoy flipping those pegs!