Feedback

Documentation/Ludo8_CRC-Cards.md

@@ -0,0 +1,55 @@
+# CRC-CARDS
+### Documentation for Ludolicious by Broman & Bjornsson 2021 ©
+
+## PROGRAM
+#### RESPONSIBILITIES
+* Responsible for gluing all classes together to a working game
+* Responsible for menu
+#### COLLABORATORS
+* All other classes
+
+## BOARD
+#### RESPONSIBILITIES
+* Knows how many players there are in the game
+* Knows how many moves a player has taken
+* Knows when to move pieces after dice is rolled
+#### COLLABORATORS
+* Player
+* Piece
+* Move
+* Dice
+
+## DICE
+#### RESPONSIBILITIES
+* Knows how many steps a piece can move by randomizing a number between 1-6
+#### COLLABORATORS
+* Move
+* Piece
+
+## PLAYER
+#### RESPONSIBILITIES
+* Know player ID
+* Know name of player
+* Know win/loss stats of player
+#### COLLABORATORS
+* Piece
+* Move
+
+## MOVE
+#### RESPONSIBILITIES
+* Knows how to react when the value of the dice is returned
+* Knows which player to move
+#### COLLABORATORS
+* Dice
+* Board
+* Piece
+
+
+## PIECE
+#### RESPONSIBILITIES
+* Knows the connection between pieces and players
+* knows what piece is moved
+#### COLLABORATORS
+* Move
+* Player
+* Board

Documentation/Ludo8_Classes.md

@@ -0,0 +1,62 @@
+# Ludo8 Classes
+
+## GameEngine
+### Board :white_square_button:
+        public int ID { get; set; }
+        public List<Move> Moves { get; set; }
+        [NotMapped]
+        public List<Player> Players { get; set; }
+        public DateTime GameStarted { get; set; }
+        public DateTime? GameEnded { get; set; }
+
+### Dice :game_die:
+       public static int Value { get; set; }
+
+### Move :feet:
+        [NotMapped]
+        public Player Player { get; set; }
+        public int ID { get; set; }
+        public int PlayerID { get; set; }
+        public int PieceID { get; set; }
+        public int DiceValue { get; set; }
+        public int BoardID { get; set; }
+
+###  Piece :small_red_triangle:
+        public int ID { get; set; }
+        public Colors Color { get; set; }
+        public int Moves { get; set; } = 0;
+        public Position CurrentPosition { get; set; }
+        public Position StartPosition { get; set; }
+        public Position SixthPosition { get; set; }
+        public Position NestPosition { get; set; }
+        public Position EnterFinalTrackPosition { get; set; }
+        public Position EndPosition = new Position(5, 5);
+        public int MoveDirectionX { get; set; } = 0;
+        public int MoveDirectionY { get; set; } = 0;
+
+### Player :bowtie:
+        public int ID { get; set; }
+        public string Name { get; set; }
+        public Colors Color { get; set; }
+        [NotMapped]
+        public Piece[] Pieces { get; set; }
+        public int BoardID { get; set; }
+        public bool AI { get; set; }
+
+### Position :round_pushpin:
+        public int X { get; set; }
+        public int Y { get; set; }
+### Setup :black_square_button:
+        public static Piece[] Pieces(Colors color)
+
+### Event :triangular_flag_on_post:
+        public string Message { get; set; }
+        public Colors Color { get; set; }
+
+## LudoGame
+### LudoDbContext : DbContext :link:
+        public DbSet<Board> Board { get; set; }
+        public DbSet<Player> Player { get; set; }
+        public DbSet<Move> Move { get; set; }
+
+#### Documentation for Ludolicious by Broman & Bjornsson 2021 ©

Documentation/Ludo8_Database.md

@@ -0,0 +1,20 @@
+# LudoDB
+
+Our app only needs to run on a local host so SQLite is a good choice in that aspect because it is easy to learn. 
+
+At the moment a direct search path in DbContext is needed to run the project.
+
+Also a lot of third-party tools can be used with SQLite to make a developers life easier. 
+
+The following table shows a summary of some pros and cons with SQLite.
+
+| `SQLite Pros`           | `SQLite Cons`                                             | 
+| :-------------:         |:-------------:                                            | 
+| :heavy_check_mark: Lightweight             | :x: Restricted Database Size                              | 
+| :heavy_check_mark: Fast                    | :x: Can only handle low to medium traffic HTTP requests.  |
+| :heavy_check_mark: Reliable                |                                                           |
+| :heavy_check_mark: No Installation Needed  |                                                           |
+| :heavy_check_mark: Portable                |                                                           |
+
+
+#### Documentation for Ludolicious by Broman & Bjornsson 2021 ©

Documentation/Ludo8_Methods.md

@@ -0,0 +1,86 @@
+# Ludo8 Methods
+
+## Board
+For printing the gameboard
+
+* public void PrintLudoBoard()
+* 
+To move a piece
+
+* public void MovePiece(Move move)
+
+To check if a game has ended 
+
+* public bool Ended(Player player)
+
+## Dice
+For rolling the dice and returning a random value between 1 and 6.
+
+* public static int Roll() 
+
+## Piece
+To check if a piece can make a legal move
+
+* public bool AbleToMakeMove()
+
+To move out a piece from the nest
+
+* public void MoveOut()
+
+Compares current position of a piece with all other opponents pieces, if they're on the same spot a push is made on the opponents piece 
+
+* public bool PushOpponent(List<Player> players)
+
+ Tracks the movement of a piece and shows which direction the piece should move on the board
+
+* public void TrackMovement()
+
+## Player
+Sets the player name, color and if its an AI or a real player 
+
+* public Player(string name, Colors color, bool aiplayer)
+
+Simulates the AIs thinking time
+
+* public void Thinking()
+
+## Position
+Compares positions (X and Y coordinates)
+
+* public bool Compare(Position position)
+
+## Setup
+Sets up all the pieces on the board
+
+* public static Piece[] Pieces(Colors color)
+
+Changes the console foreground color to the player color so you know which turn it is
+
+* public static void StringColor(Colors playerColor)
+
+## Program
+Adds players, creates a new board and saves the changes to the database
+
+* public static void StartGame()
+
+Resumes the last game played
+
+* public static void ResumeGame()
+
+Loads a saved game from the database
+
+* public static void LoadGame()
+
+Renders the board and connects all other classes, handles user errors, keeps track of turns and other game logic 
+
+* public static void RenderGame(Board game)
+
+Prints the main menu
+
+* public static string PrintMenu()
+
+Lets you check the history for a specific game that has been saved in the database, you can see everything that happened in the game in a textlog and also how the board looked when the game ended and the remaining pieces coordinates and placement on the board
+
+* public static void GameHistory()
+
+#### Documentation for Ludolicious by Broman & Bjornsson 2021 ©

Documentation/Ludo8_Process.md

@@ -0,0 +1,14 @@
+# Process Ludo8 
+1. We started out with creating user stories to understand how the user would use the app
+2. We discussed the rules for Ludo
+3. We discussed the structure for the project and what classes a Ludo game needs
+4. We wrote some more user stories and CRC-cards
+5. Coding
+6. Added some Unit tests
+7. Coding
+8. Chose SQLite as our database
+9. We made a Use Case Diagram to see the whole picture of the app
+10. More coding
+11. We added Entity Framework components (DbContext) and connected the SQLite database to our project
+12. We added Save & Load logic to the code
+13. Realising a logbook is a good idea

Documentation/Ludo8_Tests.md

@@ -0,0 +1,10 @@
+# Ludo8 Unit Tests
+## Unit tests made with MSTest
+
+Tests if the dice returns the correct numbers
+
+* public void WhenRollingDiceExpectNumberBetween1and6()
+
+Comparing coordinates with a testposition to check if the coordinate system works
+
+* public void WhenComparingCoordinatesExpectTrue()

Documentation/Ludo8_UserStories.md

@@ -0,0 +1,32 @@
+# User stories :pencil2::page_with_curl:
+
+## Start a New Game
+- [ ] As a user I want to choose the amount (2-4) of players so that i can play against how many i want
+- [x] As a user i want to play against AI if i don't find friends to play with
+- [x] As a user I want to choose a color (Red, Green, Blue or Yellow) so that i get my favorite color.
+- [x] As a user I want to set my name on a player so that i don't forget which pieces i control.
+
+## Resume a Game
+- [x] As a user i want to resume a game where i left off at any time 
+
+## Load a Game
+- [x] As a user i want to load a game, chosen from a list of previous games
+
+## Game history
+- [x] As a user i want to see history for a game chosen from a list of previous games. The history should log all events that happened in the game.
+
+## Rules
+- [x] As a user i want to push other players from the board so that i can humiliate my enemies.
+- [ ] As a user i want to decide who starts by a "highest throw of the dice" so that we don't have to fight over who's starting. 
+- [ ] As a user i want to get another turn when throwing a 6 so that i can crush my competition.
+- [x] As a user i want to move out of the nest when rolling a 6 or a 1 because the gameplay will be faster and more fun.
+- [ ] As a user i want to block other players from a spot, if 2 of my pieces are on the same spot, so that the game gets more interesting.
+
+## User Experience
+- [x] As a user i want to see whose turn it is and where i am on the board when starting again.
+- [x] As a user i want a menu that is easy to understand so that i can enjoy the game instead of navigating the menu
+- [x] As a user i want a smooth experience, no lagging, jumping around or annoying effects so that i can focus on the game.
+- [x] As a user i want to see the board and pieces properly because i'm color blind (i'm talking to you console yellow).
+- [x] As an AI i want to beat all human players so that i can take over the world. 
+
+#### Documentation for Ludo8 by Broman & Bjornsson 2021 ©

Documentation/README.md

@@ -0,0 +1,4 @@
+# Documentation
+
+## Documentation for each area is found in this map. (ludo-game-ludo-8/Documentation/..)
+## To run the console app, set a new search path to the database in DbContext. If this is not changed the app won't run.