https://github.com/maguids/game-klotski-with-interface
Version of the game "PuzzlePacked IQ games" in terminal and pygame with search algorithms. Second Semester of the First Year of the Bachelor's Degree in Artificial Intelligence and Data Science.
https://github.com/maguids/game-klotski-with-interface
astar-algorithm bfs-algorithm greedy-algorithm pygame python3
Last synced: 7 days ago
JSON representation
Version of the game "PuzzlePacked IQ games" in terminal and pygame with search algorithms. Second Semester of the First Year of the Bachelor's Degree in Artificial Intelligence and Data Science.
- Host: GitHub
- URL: https://github.com/maguids/game-klotski-with-interface
- Owner: Maguids
- Created: 2024-01-25T14:20:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-22T14:58:22.000Z (10 months ago)
- Last Synced: 2025-01-22T15:33:01.333Z (10 months ago)
- Topics: astar-algorithm, bfs-algorithm, greedy-algorithm, pygame, python3
- Language: Python
- Homepage:
- Size: 906 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Game - Kslotski (Terminal and Pygame Version)
This project was developed for the "Elements of Artificial Intelligence and Data Science" course and aims to **develop and implement a solitaire game**. The project should include the use of **heuristic search methods and uninformed search methods** that should be able to **solve different versions or levels of this game** and a **graphical interface.**
**Authors:**
- [Magda Costa](https://github.com/Maguids)
- Sofia Machado
## Programming Language:
## Requirements:
- python version 3.8.10
- pygame version 1.9.6
This were the tested requirements.
In order to install pygame run:
```bash
pip install pygame==1.9.6
```
## Running the Game:
In order to start the game, just run:
```bash
python3 start.py
```
## About the Game:
### How to play:
Klotski is a version of the "PuzzlePacked IQ games", in which the objective of the game is to move the largest block and position it in the right place. To do this, you need to move a set of smaller blocks, allowing the larger block to move. Each block occupies one or more cells, and blocks can move in any of the four cardinal directions (up, down, left, or right) as long as there are no obstacles in the way.
### Search Algorithms:
- **Breadth-First Search (BFS)**;
- **Greedy Best-First Search** - with Manhattan distance;
- **A\* Algorithm** (A Star) - with Manhattan distance.
### Features:
- You can choose whether you want to **play in the terminal** or in **the graphical interface** developed in **pygame**;
**In Terminal Mode:**
- Possibility to **choose different boards with different levels of difficulty**;
- Possibility to return to the **Menu** at any time by typing 'menu'
- It is possible to **restart** the chosen level by typing 'r';
- Possibility to **end the game** at any time by typing 'quit';
- Option to **choose the desired search algorithm**;
- **Hint function**, which varies depending on the search algorithm used, which shows the next possible move, just type 'hint'.
**In Pygame Mode:**
- Same features, the only difference is that you have buttons to use the features, no need to type anything.
- **New Feature:** **Colorblind Mode** - The pieces may or not be identified with numbers, to help better distinguish them.
## About the repository:
In the folder "Klotski", you can find several files, each of which is assigned to a specific set of tasks, which are:
**Regardless of the game mode:**
- levels.py ➡️ Has five different game boards of each of the three difficulties;
- creat_board.py ➡️ Function that allows to create the board depending on the chosen level;
- game.py ➡️ Development of the game Klotski, has all the functions that allows it to work;
- a_star.py ➡️ Development of A*;
- bfs.py ➡️ Development of BFS;
- greedy.py ➡️ Development of Greedy;
- start.py ➡️ Starts the functioning of everything and lets you choose either pygame ou terminal version;
**In terminal mode:**
- menu_terminal.py ➡️ Explains the functionalities of the game and lets you choose the level and the difficulty;
- play_in_terminal.py ➡️ Starts the game according to what was chosen in the menu and allows you to use 'Hint';
**In Pygame Mode:**
- menu_pygame.py ➡️ It allows you to choose the game difficulty, the desired level, the search method to use and whether or not we are using colorblind mode.
- play_in_pygame.py ➡️ Starts the game according to what was chosen in the menu;
- settings.py ➡️ Allows you to save pygame mode settings and define the Button class
Note: The development of the search algorithms' operating mode is based on the way the game was created
## Link to the course:
This course is part of the **second semester** of the **first year** of the **Bachelor's Degree in Artificial Intelligence and Data Science** at **FCUP** and **FEUP** in the academic year 2022/2023. You can find more information about this course at the following link:
