From a773570a8c90c032d1800e90f7d81dd0e45ee650 Mon Sep 17 00:00:00 2001 From: Sebastian Veuskens <46533771+SebastianVeuskens@users.noreply.github.com> Date: Mon, 27 Nov 2023 20:39:34 +0100 Subject: [PATCH] Project Definition README --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c64e1b4..e07d5e5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ -# Battleship-AI -A platform that models an AI strategy in the game "Battleship," visually presenting its move-by-move decisions from a specified starting point. +# Project Definition + +*Author: Sebastian Veuskens* + +*Project definition approach was inspired by [cowinkiedink](https://www.reddit.com/r/learnprogramming/comments/mumrgn/how_to_plan_and_build_a_programming_project_a/)* + +*A guideline for project workflow using github projects is available [here](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects) along [best practices](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects) on how to leverage them.* + +## 1. What is the project? + +A platform that demonstrates at least one AI approach to try to find a successful strategy in the popular game [Battleship](https://en.wikipedia.org/wiki/Battleship_(game)) for a given starting position. A visual display of the game board will display the starting position as well as the move decisions of the AI in a step-by-step manner. Different board sizes and number of boats can be selected to account for complexity. + +## 2. What is the MVP? + +The minimal viable product is a simple AI that is able to play a game in accordance with the rules and performs better than random guessing. A (non-interactive) local visual display of the game and its steps has to be implemented. + +## 3. What are the nice2haves? + +- Compare more than one AI approach to each other. Especially a reinforcement learning algorithm in comparison with a bayes/naive approach would be interesting. + +- Having a visual platform on a website instead of a local machine. + +- Render the display of the board to make it look more appealing. + +- An interactive platform that lets people chose the size of the board, number of boats, the algorithm and when to go to the next step. + +- A fully-responsive platform that lets users play games against the AI. + - For this feature, more definitions for the AI have to be made about the choice of starting position as well as the opponents gameplay as an additional input. + +## 4. When will the project be complete? + +When a visually appealing platform for the game is available that allows the demonstrations of the algorithms.