This repo is accompanying source code to Building Tic Tac Toe in Kotlin with Functional Programming Blog Post. The project aims to showcase functional programming principles and concepts using Kotlin's functional features.
- Implemented using pure functional programming principles
- Utilizes the arrow-kt library
- Uses immutable data structures and avoids side effects in the core using an IO monad
- Utilizes higher-order functions, lambda expressions, and function composition
- Supports human vs. human gameplay
- Provides a simple command-line interface for user interaction
Requires Java 17 to be installed, alternatively docker can be used via batect To get started with the Tic-Tac-Toe game, follow these steps:
-
Clone the repository:
git clone https://github.com/monkey-codes/fp-kotlin-tictactoe.git
-
Navigate to the project directory:
cd fp-kotlin-tictactoe -
Build the project using Gradle:
./gradlew build
-
Run the game:
./gradlew run
This will start the game and display the game board in the command-line interface.
Requires docker. Follow the checkout steps above (step 1 & 2 ), then:
-
Build the project using Batect:
./batect build
-
Run the game:
./batect run
The game is played on a 3x3 grid. Each player takes turns placing their symbol (either 'X' or 'O') on an empty cell. The goal is to form a horizontal, vertical, or diagonal line of three symbols before the opponent does.
When it is your turn, you will be prompted to enter the row and column numbers of the cell where you want to place your symbol. The row and column numbers are zero-based, meaning they range from 0 to 2.
For example, to place your symbol in the top-left cell, you would enter 0 for the row and 0 for the column.
Enjoy playing Tic-Tac-Toe!
classDiagram
Game <|-- Won
Game <|-- Draw
Game <|-- InProgress
Move --> Coordinates
Move --> Symbol
Move .. InProgress : make
class Game{
+List~List~Symbol~~ state
}
class Won{
+Symbol winner
}
class Draw{
}
class InProgress{
+Symbol nextPlayer
+make(move) Either~GameError|Game~
}
class Coordinates{
+Int row
+Int col
}
class Move {
+Coordinates coordinates
+Symbol symbol
}
class Symbol {
CROSS
NOUGHT
BLANK
}
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#aed7ea',
'primaryTextColor': '#000',
'primaryBorderColor': '#007db8',
'lineColor': '#000',
'secondaryColor': '#006100',
'tertiaryColor': '#fff',
'edgeLabelBackground': '#fff',
'textColor': '#000'
}
}
}%%
flowchart LR
subgraph SE[Side Effect 'Descriptions']
subgraph IOS[IO Monad]
Screen(Screen)
end
subgraph IOI[IO Monad]
Input(Input)
end
Screen(Screen) --flatMap--> Input(Input)
end
style SE fill:#f8f8f8,stroke:#f3f3f3
subgraph FC[Functional\nCore]
Input --make move--> Game(Game)
Game --Either GameError or Game--> Input
Input --flatMap-->Screen
end
style FC fill:#f8f8f8,stroke:#f3f3f3
Contributions are welcome! If you have any ideas, suggestions, or improvements, please feel free to open an issue or submit a pull request.
Before contributing, please ensure that your code adheres to the project's coding conventions and is properly tested.
This project is licensed under the MIT License.
This project was inspired by the functional programming principles and concepts in Kotlin as described in Functional Programming in Kotlin by Marco Vermeulen. The project also makes use of the arrow-kt library.