https://github.com/yasmeentarek1/peg_reversal_game

Board game where the goal is to flip all black pegs on board to white, with pegs flipping only if adjacent to a white peg.
https://github.com/yasmeentarek1/peg_reversal_game

functional-programming haskell recursion

Last synced: about 2 months ago
JSON representation

Board game where the goal is to flip all black pegs on board to white, with pegs flipping only if adjacent to a white peg.

• Host: GitHub
• URL: https://github.com/yasmeentarek1/peg_reversal_game
• Owner: YasmeenTarek1
• Created: 2024-09-16T00:27:55.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T01:48:38.000Z (5 months ago)
• Last Synced: 2024-12-15T01:34:35.588Z (2 months ago)
• Topics: functional-programming, haskell, recursion
• Language: Haskell
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🎯 Peg Reversal Game

## Project Overview

The **Peg Reversal Game** is a challenging single-player board game where the objective is to flip all the pegs on a '+' shaped board to white. Starting with one white peg and all others black, players must strategically flip pegs while adhering to the rules of adjacency. The game provides an engaging puzzle-solving experience that requires planning and logical thinking.

## How to Play

1. The board is shaped like a '+' with pegs, initially set with one white peg, and all others black.

2. A player can flip a black peg to white only if at least one adjacent peg (up, down, left, or right) is already white.

3. The game is won when **all pegs on the board are flipped to white**.

4. Explore all possible moves and strategize to reach the winning state efficiently.

---

## Features

- 🛠️ **Board Initialization**  

  Generates the initial board state, ensuring one white peg and the rest black, based on a user-specified position.

  

- ✅ **Move Validation**  

  Ensures moves adhere to the rules of adjacency and legality within the current board configuration.

  

- 🏆 **Goal Check**  

  Automatically evaluates the board to determine if the winning condition (all white pegs) is achieved.

  

- 🔍 **Explore Possible States**  

  Provides a comprehensive list of all unique next board states, helping players visualize their options.

  

---

## Technologies

- 🏗️ **Haskell**: Leveraging the power of functional programming for clarity and efficiency.  

- 🧩 **Functional Programming Paradigms**: Employing immutability, recursion, and pure functions.  

- 🔄 **Recursion**: For seamless state transitions and board evaluations.  

---

## Functions

- **`createBoard :: Position -> Board`**  

  Initializes the board with one white peg at the given position. Returns an error for invalid positions.

- **`isValidMove :: Move -> Board -> Bool`**  

  Checks if a move is legal based on the current board state.

- **`isGoal :: Board -> Bool`**  

  Returns `True` if all pegs on the board are white, otherwise `False`.

- **`showPossibleNextStates :: Board -> [State]`**  

  Lists all possible next states from the current board configuration.