Merge branch 'src' into main

README.md

@@ -0,0 +1,118 @@
+![Mapello](images/LAIG3_T01_G03_1.png)
+
+<h3 align="center">
+
+A fun *Reversi* derivative board game for 2 players
+</h3>
+<h4 align="center">Made with WebGL and Prolog</h4>
+
+----
+
+## Description
+
+The goal of this project was to develop a human-like environment to play a browser version of a board game. 
+
+The board game elected was [Mapello](docs/MAPELLO_EN.pdf) and the tech behind this project consists of: 
+* a [backend](backend/) game engine powered by the logic programming language **Prolog**.
+
+* a [frontend](frontend/) environment created with the WebGL technology, entirely written in **JavaScript**.
+
+----
+
+## Demo
+
+![Demo](images/mapello.gif)
+
+----
+
+## Run
+
+To run this project, first ensure you have `Docker` and `docker-compose` installed.
+
+A [Sicstus](https://sicstus.sics.se/download4.html) license for the Prolog development system is also needed. Download the Linux version, apply your license and copy the `sicstus` folder installation (with this name) inside the `backend` folder of this project.
+
+After that, run:
+
+* `docker-compose up -d` to build up the project containers and start them.
+  * When both of the containers have been created, go to `http://0.0.0.0:8080` in your browser and start playing.
+* `docker-compose down` to stop the containers.
+
+----
+
+## Mapello Rules
+
+In the Mapello game, for two players, **the pieces used are black and white reversible discs**, with the color facing up identifying a player's piece. 
+
+![Init](images/mapello-init.png)
+
+The board, with a **10x10 square configuration,** is delimited by walls, and the playable area corresponds to the center of the board, 8x8. **Two pieces of each player are placed in the four central cells**, in a diagonal pattern. 
+
+On the board, there are also other pieces of each of the following types: 
+* **walls**, extra and immovable, in any position of the playable area; 
+* **bonuses**, placed in the playable area and rewarding, with 3 points, the player who plays on them; 
+* **jokers**, acting as the current player's pieces, which exist only on the edges, outside the playable area. 
+
+**The players play alternately**, with the black player starting. **On each turn, the player places a piece on an empty space, or bonus, adjacent to an opponent's piece.** 
+
+![Example](images/mapello-example.png)
+
+**The opponent's pieces that are continuously between the new piece and another piece of the current player, or a joker, either diagonally, vertically, or horizontally, are turned upside down to the current player's color.** 
+
+**A valid move must cause at least one of the opponent's pieces to be flipped.** If the player cannot make a valid move, he passes the turn to his opponent. 
+
+**The game ends when neither player has a valid move.** When it ends, the points are counted by adding the number of each player's pieces present on the board to their accumulated bonuses, and the player with the most points wins.
+
+----
+
+## Game Instructions
+
+### Start Menu
+
+![Start Menu](images/start-menu.png)
+
+> Choosing Players and Board:
+
+1. To choose the players' types, select *Player* or *Computer* from the *Type* dropdown menus.
+2. To choose the difficulty level, in case the player is a *Computer*, select *Random* or *Greedy* from the *Level* dropdown menu. 
+3. Select the type of the generated board in the *Board* dropdown menu - *Random* or *Default*.
+4. Press **Play** to start the game
+
+### Interface
+
+![Interface](images/interface.png)
+
+> Cameras, Themes, Lights, Undo and Replay:
+
+In the interface you can select the active camera, theme and lights. In addition, there are Undo and Replay buttons for the respective functions.
+
+### How to play
+
+![How to play](images/LAIG3_T01_G03_2.png)
+
+> Piece selection and user interaction throughout the game:
+
+* The scoreboard indicates which player must play and each player's points (bonus).
+* The player has 60 seconds to play, and if not, the game is over.
+* To play, the player whose color is indicated on the marker board can choose any piece on the auxiliary board by clicking on it.
+* When choosing a piece, the valid positions are highlighted.
+* To play the piece, simply click on one of the highlighted positions.
+* The turn passes to the next player and the points will be updated if any bonuses are captured.
+* At any time during the game, the player can Undo the play, going back to the previous move, or Replay to see all the moves made so far.
+* When there are no more valid moves for any player, the game ends and the totals can be seen on the scoreboard, as well as the winner.
+
+----
+
+## Screenshots
+
+| ![](images/LAIG3_T01_G03_2.png) | ![](images/LAIG3_T01_G03_3.png) |
+|----|----|
+| ![](images/LAIG3_T01_G03_4.png) | ![](images/LAIG3_T01_G03_5.png) |
+
+----
+
+## Authors
+
+| Name             | E-Mail               |
+| ---------------- | ---------------------|
+| Diana Freitas    | [email protected] |
+| Eduardo Brito    | [email protected] |

backend/Dockerfile

@@ -0,0 +1,9 @@
+FROM ubuntu:latest
+
+COPY . /home/
+
+WORKDIR /home/
+
+ENV PATH "$PATH:/home/sicstus/bin"
+
+CMD ["sicstus", "-l", "server.pl", "--goal","server."]

backend/boards.pl

@@ -0,0 +1,71 @@
+% Initial Boards
+
+% initial(+Key, -Board) - Creates the initial Game State identified by Key
+% Create default initial board
+initial(default, [
+    [wall,  wall,  wall,  wall,  joker, wall,  wall,  wall,  wall, wall],
+    [wall,  wall,  empty, bonus, empty, empty, bonus, empty, wall, wall],
+    [wall,  empty, empty, empty, empty, empty, wall,  empty, empty, wall],
+    [joker, bonus, wall,  empty, empty, empty, empty, empty, bonus, joker],
+    [joker, empty, empty, empty, black, white, empty, empty, empty, wall],
+    [wall,  empty, empty, empty, white, black, empty, empty, bonus, wall],
+    [wall,  bonus, empty, empty, empty, empty, empty, wall,  empty, joker],
+    [joker, empty, empty, wall,  empty, empty, empty, empty, empty, wall],
+    [wall,  wall,  empty, bonus, empty, empty, empty, bonus, wall,  wall],
+    [wall,  wall,  wall,  joker, wall,  wall,  wall,  joker, wall,  wall]
+    ]).
+
+% Create random board
+initial(random, Board) :- 
+    empty(Empty),
+    random_jokers(Empty, B1, 8), 
+    random_walls(B1, B2, 8), 
+    random_bonus(B2, Board, 8).
+
+% random_jokers(+Board, -NewBoard, +N) - Places N random jokers in Board, returning a NewBoard
+random_jokers(Board, Board, 0).
+
+random_jokers(Board, NewBoard, N) :-
+    N > 0,
+    findall(Row-Col,(between(0,9,Row), between(0,9,Col), get_matrix_value(Board, Row, Col, wall)), Walls),
+    random_member(Row-Col, Walls),
+    set_matrix_value(Board, Row, Col, joker, B1),
+    N1 is N - 1,
+    random_jokers(B1, NewBoard, N1).
+
+% random_walls(+Board, -NewBoard, +N) - Places N random walls in Board, returning a NewBoard
+random_walls(Board, Board, 0).
+
+random_walls(Board, NewBoard, N) :-
+    N > 0,
+    findall(Row-Col,(between(1,8,Row), between(1,8,Col), get_matrix_value(Board, Row, Col, empty)), Empties),
+    random_member(Row-Col, Empties),
+    set_matrix_value(Board, Row, Col, wall, B1),
+    N1 is N - 1,
+    random_walls(B1, NewBoard, N1).
+
+% random_bonus(+Board, -NewBoard, +N) - Places N random bonus in Board, returning a NewBoard
+random_bonus(Board, Board, 0).
+
+random_bonus(Board, NewBoard, N) :-
+    N > 0,
+    findall(Row-Col,(between(1,8,Row), between(1,8,Col), get_matrix_value(Board, Row, Col, empty)), Empties),
+    random_member(Row-Col, Empties),
+    set_matrix_value(Board, Row, Col, bonus, B1),
+    N1 is N - 1,
+    random_bonus(B1, NewBoard, N1).
+
+
+% empty(-Board) - Returns an empty Board
+empty([
+[wall,  wall,  wall,  wall,  wall, wall,  wall,  wall,  wall, wall],
+[wall,  empty, empty, empty, empty, empty, empty, empty, empty, wall],
+[wall,  empty, empty, empty, empty, empty, empty, empty, empty, wall],
+[wall, empty, empty, empty, empty, empty, empty, empty, empty, wall],
+[wall, empty, empty, empty, black, white, empty, empty, empty, wall],
+[wall,  empty, empty, empty, white, black, empty, empty, empty, wall],
+[wall,  empty, empty, empty, empty, empty, empty, empty,  empty, wall],
+[wall, empty, empty, empty, empty, empty, empty, empty, empty, wall],
+[wall,  empty, empty, empty, empty, empty, empty, empty, empty, wall],
+[wall,  wall,  wall,  wall, wall,  wall,  wall,  wall, wall,  wall]
+]).