| Lim Jia Jing | [Github](https://github.com/LimJiaJing) | [Portfolio](team/limjiajing.md)
+
| Lu Sicheng | [Github](https://github.com/Isabella-L) | [Portfolio](team/lusicheng.md)
+
| Shi Zhansen | [Github](https://github.com/DuckWillow) | [Portfolio](team/shizhansen.md)
+
| William Wahyudi | [Github](https://github.com/maxwireddevs) | [Portfolio](team/williamwahyudi.md)
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
index 64e1f0ed2b..c1a895dc49 100644
--- a/docs/DeveloperGuide.md
+++ b/docs/DeveloperGuide.md
@@ -1,38 +1,226 @@
# Developer Guide
+* [Acknowledgements](#acknowledgements)
+* [Setting Up, getting started](#setting-up-getting-started)
+* [Design](#design)
+ * [Architecture](#architecture)
+ * [Command Component](#command-component)
+ * [Game Component](#game-component)
+ * [Content Component](#choose-the-game-content)
+* [Implementation](#implementation)
+* [Product Scope](#product-scope)
+* [User Stories](#user-stories)
+* [Glossary](#glossary)
+* [Manual Testing](#instructions-for-manual-testing)
+
## Acknowledgements
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+* [reference code for testing System.out.println()](https://www.baeldung.com/java-testing-system-out-println)
+* [reference code for accessing wiki](https://github.com/fastily/jwiki)
+* [SE-EDU AB3 Developer Guide Format](https://se-education.org/addressbook-level3/DeveloperGuide.html)
+
+## Design
+
+> :bulb: **Tip:** The `.puml` files used to create diagrams in this document
+> can be found in the [diagrams](https://github.com/se-edu/addressbook-level3/tree/master/docs/diagrams/) folder.
+
+### Architecture
+
+
+
+The Architecture diagram above explains the high-level design of the Typists app.
+Given below is a quick overview of main components and how they interact with each other.
+
+**Main Components of the architecture**
+The `Main` class is the entry point of Typist. It is responsible for parsing and running various user's command.
+
+The other core components of Typist:
+* `ui`: The Ui of the app.
+* `command`: Consists of `CommandFactory` which parses user inputs, and various `command` objects.
+* `common`: A collection of classes used by multiple other components.
+* `content`: Holder for the content and logic for `content` command
+* `game`: Game, game summary and game record executor.
+* `storage`: Game storage executor.
+
+### Command Component
+**API:** `CommandFactory.java`
+
+The `Command` component implements the Factory Design Pattern to parse user commands.
+
+Here’s a (partial) class diagram of the `Command` component:
+
+
+
+How the `Command` component works:
+1. Typists `Main` calls upon the `CommandFactory` class to parse the user input.
+2. The `CommandFactory` returns a `Command` object (more precisely, an object that implements it e.g., `GameCommand`).
+3. `Main` will then execute the `Command` by calling `.run(args)` method of the `Command`.
+
+### Game Component
+
+**How the Game Component works:**
+* The `Game` component consists of 2 parts:
+ 1. The actual game execution classes;
+ 2. and the game record classes
+* For 1: When for a `Game` object, the `.runGame()` is the main method that runs the game until termination and
+the`.gameSummary()` displays the summary and stores game data.
+* For 2: Game Record Management, which interacts with record storage, will be explained with further detail in [later section](#proposed-view-statistics-feature).
+
+For instance:
+When game is running from the CLI:
+* The `.run(args)` of `TimeGameCommand` is called, a `TimeLimitGame` object is created.
+* Then, `.run()` method of `TimeLimitCommand` is executed, a Time Limit Game will start running
+until game ends(i.e. timer's up).
+* `.gameSummary()` method will then generate the summary of the game.
+
+The (partial) Class Diagram bellow illustrates the structure of `game` component:
+{some class diagram}
+
+There are 2 constructors in `TimeModeGame` class, each handling different number of parameters specified.
+
+As from the diagram, `WordLimitGame` and `TimeLimitGame`, the 2 major game execution classes inherits from the `Game` Class.
+However, their implementations and functionality varies on many parts due to them being 2 different games.
+Hence, The section below explains in greater detail how [Word Mode](#word-limit-game) and [Time Mode](#time-limit-game) of Typist game are implemented.
+
+
+### Word Limit Game
+
+Sequence Diagram for Word Mode Game:
+
+
+
+The Sequence Diagram above illustrates the working process of the `WordLimitGame` class.
+
+### Time Limit Game
-## Design & implementation
+The Sequence Diagram below illustrates the working process of the `TimeLimitGame` when the `.runGame` method is called:
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+
+### Choose the game content
+
+Once the game starts, the main class instantiates a Content object containing a string, which is set to a default
+value (lorem ipsum paragraph). The string can only be changed through the setContent() method.
+
+Users can input the 'content' command to start the text selection.
+
+There are 3 types:
+
+ 1. Opening paragraphs from famous books
+ 2. Custom Wikipedia article
+ 3. Random words
+
+The following UML diagram illustrates the way content selection works in the program.
+
+
+
+There only exists one private content string for all sessions. Each time a set method is called, the string is changed
+depending on the choices that the user made throughout the process. Whenever the user starts a game, the getContent()
+method is called and the text is set accordingly.
+
+## Implementation
+
+### \[Proposed\] View Statistics feature
+#### \[Proposed Implementation\]
+The top-level logic of view statistics feature resides in ViewCommand. It implements the Command
+interface. The key method of the class is `executeCommand()`.
+`executeCommand()` logic:
+1. Calls the retrieveStatistics() method of StatisticsManager to get the statistics.
+2. Calls the displayStatistics() method of ViewCommandUi to display the statistics retrieved.
+
+StatisticsManager performs the logic for processing the game records to obtain the statistics.
+Its key methods are:
+* `retrieveStatistics()` - Decides which of the three methods below to run
+* `calculateBestStatistics()` - Returns the best statistics over the past n games
+* `calculateWorstStatistics()` - Returns the worst statistics over the past n games
+* `calculateAverageStatistics()` - Returns the average statistics over the past n games
+
+Given below is an example usage scenario and how the program implements the feature.
+
+Step 1: The user launches the application (scenario assumes that there are several game records already stored in the text files).
+
+Step 2: The user executes `view -m best -g time -n 4` to view his/her best statistics for the time-limited game mode over the past 4 games.
+
+Step 3: A ViewCommand object is then instantiated.
+
+
+
+Step 4. ViewCommand calls the retrieveStatistics() method of StatisticsManager.
+
+
+Step 5: StatisticsManager creates a GameRecordsManager object.
+* The constructor of GameRecordsManager calls the readGameRecords() method of the Storage class to retrieve the gamer's past game records from the text files.
+
+
+Step 6. StatisticsManager then calls getGamesRecords() method of GameRecordsManager() and self-invokes calculateBestStatistics().
+* Calculated statistics is returned.
+
+Step 7. ViewCommand calls the displayStatistics() method of the ViewCommandUi class to display the statistics.
+
+
+
+The following sequence diagram shows how the above scenario is executed.
+
+
+
+
+#### Alternative Implementation
+* One implementation considered is to do away with the retrieveStatistics() method and immediately call one of calculateBestStatistics,
+calculateWorstStatistics() or calculateAverageStatistics() based on the gamer's imput using a switch statement. This implementation choice
+was not used because it violates the Single Responsibility Principle and does not do SLAP well.
+* Another implementation considered was for GameRecordsManager to do the main logic. This implementation was not done as it violates the
+Single Responsibility Principle.
+
## Product scope
+Our product is a typing game, intent to provide enjoyment for people who are familiar with the CML.
+
### Target user profile
-{Describe the target user profile}
+The target user profile includes bored people who are looking for a fun way to entertain themselves while working on the command line.
### Value proposition
-{Describe the value proposition: what problem does it solve?}
+It solves the lack of entertainment alternatives on the CLI.
## User Stories
|Version| As a ... | I want to ... | So that I can ...|
|--------|----------|---------------|------------------|
|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
-
-## Non-Functional Requirements
-
-{Give non-functional requirements}
+|v1.0|user|customize the time limit to finish a game|train myself to type faster|
+|v1.0|user|customize the word limit, in multiples of 100|have an optimal gaming experience by being able to choose my preferred length of text for the game|
+|v1.0|user|choose text from famous books, randomly generated text or customized text for my game|make my gaming experience more fun and fulfilling|
+|v1.0|typist|view my error rate|know on average, what my error rate is|
+|v1.0|typist|see my word per minute after I've finished a game|know my typing speed|
+|v2.0|gamer|view my past records|see how I have improved over time|
+|v2.0|gamer|clear my past records|have a fresh start|
+|v2.0|typist|see the words I typed wrongly after I've finished a game|know which words I have to practice more|
## Glossary
-* *glossary item* - Definition
+* Mainstream OS: Windows, Linux, Unix, OS-X
+* Time Limit Game: A game that ends only when timer stops.
+* Word Limit Game: A game that ends only when all the words has been inputted.
## Instructions for manual testing
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+### Launch and Shutdown
+1. Initial Launch
+ 1. Download the jar file and copy into an empty folder
+ 2. Double-click the jar file.
+ Expected: shows the starting page and current version of Typist
+2. Obtaining past game records
+ 1. Exit the game through command `bye`.
+ 2. Re-launch the app by double-clicking hte jar file.
+ Expected: The record of previous games is retained.
+
+### Opening a game
+1. Opening a game with optional operands
+ 1. Test case: `game -time 0`
+ Expected: A warning message about error on limit input is shown.
+ The game will still start as if no time limit is specified.
+ User will be asked to "Enter how long you want the game to run: ".
+ 2. Test case: `game -time 30 -sn`
+ Expected: A game will start running. Timer starts immediately together the first line of sentence to be typed is displayed.
+
\ No newline at end of file
diff --git a/docs/README.md b/docs/README.md
index bbcc99c1e7..b11ed62382 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,11 @@
-# Duke
+# Typist
-{Give product intro here}
+Welcome to Typists!
+Typist is a command line interface(CLI) typing game targeted at users who love to type and are
+familiar with the command line interface.
+There are two game modes in types:
+* time-limited (aim to type as much as possible in a limited time)
+* and word-limited (aim to type a chosen number of words as fast as possible).
Useful links:
* [User Guide](UserGuide.md)
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index abd9fbe891..37f6f5844c 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -1,42 +1,326 @@
# User Guide
+1. [Introduction](#1-introduction)
+2. [Quick Start](#2-quick-start)
+3. [Features](#3-features)
+ 1. [Set Content](#31-set-content-content)
+ 2. [Open Game](#32-open-game-game)
+ 1. [Word Mode Game](#321-word-limit-game)
+ 2. [Time Mode Game](#322-time-limit-game)
+ 3. [View history](#33-view-past-records-history)
+ 4. [Clear history](#34-clear-past-records-clear)
+ 5. [Display Summary](#35-view-summary-of-game)
+ 6. [Save Data](#36-saving-the-data)
+ 7. [Man Pages](#37-man-pages-man)
+4. [FAQ](#faq)
+5. [Command Summary](#command-summary)
-## Introduction
+## 1. Introduction
-{Give a product intro}
+Welcome to Typist! The ultimate CLI typing game!
+Go to [Quick Start](#quick-start) to get started!
-## Quick Start
+## 2. Quick Start
-{Give steps to get started quickly}
+1. Ensure that you have Java 11 installed in your local environment.
+2. Down the latest version of `Typist` from [here](https://github.com/AY2122S1-CS2113-T13-4/tp/releases).
+3. Navigate to the folder containing the jar file and run `java -jar tp.jar`.
+4. If everything goes well, the command interface should display the following:
+
+```
+ | Typist - Version 2.0
+ | ===========================================================
+ | ______ _ __
+ | /_ __/_ ______ (_)____/ /_
+ | / / / / / / __ \/ / ___/ __/
+ | / / / /_/ / /_/ / (__ ) /_
+ | /_/ \__, / .___/_/____/\__/
+ | /____/_/
+ | Welcome to Typist -- the ultimate cli typing game.
+ | Brought to you by -- AY2122S1-CS2113-T13-4.
+ | Manual:
+ | content: set the content
+ | game -time: start a new time game
+ | game -word: start a new word game
+ | history -g GAME_MODE [-n NUMBER_OF_RECORDS]: view past game records
+ | clear [-g GAME_MODE]: clear all game records
+ | bye: exit typist
+ | ===========================================================
+```
-1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+## 3. Features
-## Features
+### Notes about the command format:
-{Give detailed description of each feature}
+* Words in UPPER_CASE are arguments to be supplied by the user.
+e.g. in `history -g GAME_MODE`, `GAME_MODE` is an argument which can be used as `history -g time`.
+* Items in square brackets are optional.
+e.g. `-g GAME_MODE [-n NUMBER_OF_RECORDS]` can be used as `-g time -n 9` or as `-g time`
+* Parameters can be in any order.
+e.g. if command specifies `history -g GAME_MODE [-n NUMBER_OF_RECORDS]`, `history [-n NUMBER_OF_RECORDS] -g GAME_MODE`
+is also acceptable.
+Note: One parameter is defined as the option e.g. `-g` and its value (if there is such a field) e.g. `time`
+* If a parameter is expected only once in the command, but you specified it multiple times,
+only the first occurrence of the parameter will be taken
+e.g. if you specify `history -g time -g time -n 10`, only `history -g time -n 10` will be taken.
+* For commands which have a `-h` parameter, if `-h` is among the parameters provided, all other parameters will be
+ignored and the guide for that command will be displayed.
+e.g `history -g time -h -n 10` will be interpreted as `history -h`.
+* All parameters which do not conform to the command syntax will be ignored.
+e.g.2 `clear -gtime` will be interpreted as `clear`
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+### 3.1 Set Content: `content`
+Set the typing content before the game.
+There are two game modes in Typist:
-Format: `todo n/TODO_NAME d/DEADLINE`
+* time-limited (aim to type as much as possible in a limited time)
+* word-limited (aim to type a chosen number of words as fast as possible)
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.
+Format: `content` `1-3` `[optional]`
-Example of usage:
+After entering `content`, user can type an integer from 1-3 to choose from following:
-`todo n/Write the rest of the User Guide d/next week`
+1. Opening of famous books
+2. Wikipedia article
+3. Random sentence of custom length
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+
+
+Examples
+* `content` `1` `3`
+
+
+
+### 3.2 Open Game: `game`
+Start a typing game.
+Format: `game -GAME_MODE [GAME_LIMIT] [-c] [-sn]`
+
+* GAME_MODE
+ * `word` for game in Word Limit Mode
+ * `time` for game in Time Limit Mode
+
+#### 3.2.1 Word Limit Game
+ In a Word-Limit game, user needs to specify the total number of words
+they want to type. Game will terminate once they finish typing the specified
+number of words.
+* Format: `game -word [WORD_LIMIT] [-c] [-sn]`
+* Example: `game -word`
+* ```
+ game -word
+ | Enter how many words you want the game to run:
+ 10
+ | Timer will start once you entered "start":
+ start
+ | Lorem Ipsum is simply dummy
+ lorem ipsum is simply dummy
+ | Your progress:5/10
+ ```
+* Exit: `Exit` allows user to terminate the current game.
+
+#### 3.2.2 Time Limit Game
+In a Time-Limit Game, user needs to specify the duration
+they want to type. Timer will stop once the duration is reached
+and terminates the game at the same time.
+>**NOTE**:
+> The time limit that user inputs needs to be a positive integer that represents time in seconds.
+> It also needs to be multiple of 30.
+
+* Format: `game -time [TIME_LIMIT] [-c] [-sn]`
+* Example: `game -time`
+* ```
+ game -time
+ | Enter how long you want the game to run:
+ 60
+ | Timer will start once you entered "start":
+ start
+ | Lorem Ipsum is simply dummy text of the printing and
+ Lorem Ipsum is simply dummy text of the printing and
+ | Timer's Up!
+ ```
+
+ **Exceeding Time:**
+ When you are at the last sentence. Even though Timer is up, the game will wait
+ until you finish the last sentence to terminate. You will be informed of the exceeding time,
+ and it will count towards your game summary.
+
+#### Optional arguments
+* SET_CONTENT `-c`: allows user to set input content before game starts.
+* START_NOW `-sn`: allows timer to start immediately without the "start timer" prompt.
+* GAME_LIMIT: a positive integer that sets the word/time limit of the game
+ without the "enter limit" prompt.
+ > **NOTE**:
+ > if you want to specify GAME_LIMIT, it needs to be right after the GAME_MODE argument.
+ > If the GAME_LIMIT entered is invalid, game will still start but with the "enter limit" prompt.
+
+ > Any ERROR in the _optional arguments_ will prompt a message but will not terminate the command.
+ > The game will still start as if the optional argument is not given.
+
+
+
+Example 1: `game -time 30`
+Expected outcome:
+```
+game -time 30
+ | Timer will start once you entered "start":
+start
+ | Lorem Ipsum is simply dummy text of the printing and
+```
+Example 2: `game -time 30 -sn`
+Expected outcome:
+```
+game -time -sn
+ | Enter how long you want the game to run:
+30
+ | Lorem Ipsum is simply dummy text of the printing and
+```
+Example 3: `game -word 20 -sn -c`
+Expected outcome:
+```
+(\
+\'\
+ \'\ __________
+ / '| ()_________)
+ \ '/ \ ~~~~~~~~ \
+ \ \ ~~~~~~ \
+ ==). \__________\
+ (__) ()__________)
+ | Content selection (input 0 to go back):
+ | 1. Opening of famous books
+ | 2. Wikipedia article
+ | 3. Random sentence of custom length
+ | Enter your selection:
+```
+
+
+
+### 3.3 View past records: `history`
+View past game records.
+Format: `history -g GAME_MODE [-n NUMBER_OF_RECORDS] [-h]`
+* NUMBER_OF_RECORDS defaults to all records if not provided
+* Possible arguments for GAME_MODE are - `word` or `time`
+
+
+
+Examples
+* `history -g time -n 10`
+* `history -g word`
+
+
+
+Example of usage
+```
+history -g time -n 1
+ __ _____________________ ______ __
+ / / / / _/ ___/_ __/ __ \/ __ \ \/ /
+ / /_/ // / \__ \ / / / / / / /_/ /\ /
+ / __ // / ___/ // / / /_/ / _, _/ / /
+/_/ /_/___//____//_/ \____/_/ |_| /_/
+Game Mode: Time-limited
+WPM: 49.71
+Total Time taken for the game: 36.21 seconds
+Number of Wrong Words: 0/30|0.00%
+Number of Correct Words: 30/30|100.00%
+Mistakes: No words typed wrongly.
+==================================================================
+```
+
+### 3.4 Clear past records: `clear`
+Clear all past game records.
+Format: `clear [-g GAME_MODE] [-h]`
+* GAME_MODE defaults to `all` if not provided
+* Possible arguments for GAME_MODE are - `word`, `time` or `all`
+
+
+
+Examples
+* `clear -g time`
+* `clear`
+
+
+
+Example of usage
+```
+clear -g time
+ ________ _________ ____ ____ ________________ ____ ____ _____
+ / ____/ / / ____/ | / __ \ / __ \/ ____/ ____/ __ \/ __ \/ __ \/ ___/
+ / / / / / __/ / /| | / /_/ / / /_/ / __/ / / / / / / /_/ / / / /\__ \
+/ /___/ /___/ /___/ ___ |/ _, _/ / _, _/ /___/ /___/ /_/ / _, _/ /_/ /___/ /
+\____/_____/_____/_/ |_/_/ |_| /_/ |_/_____/\____/\____/_/ |_/_____//____/
+
+Successfully cleared Time-limited game records.
+```
+
+### 3.5 View summary of game
+View summary of a just-played game.
+Typists automatically generates and displays the summary after a game ends.
+The summary consists of the following fields:
+* Game mode
+* Word per minute (WPM)
+* Total time taken for the game
+* Number of wrong words and its percentage
+* Number of correct words and its percentage
+* Wrongly and not typed words (Mistakes)
+
+
+
+Example of usage
+```
+ _____ __ ____ _____ ______ ______ __
+ / ___// / / / |/ / |/ / | / __ \ \/ /
+ \__ \/ / / / /|_/ / /|_/ / /| | / /_/ /\ /
+ ___/ / /_/ / / / / / / / ___ |/ _, _/ / /
+/____/\____/_/ /_/_/ /_/_/ |_/_/ |_| /_/
+Game Mode: Time-limited
+WPM: 49.71
+Total Time taken for the game: 36.21 seconds
+Number of Wrong Words: 0/30|0.00%
+Number of Correct Words: 30/30|100.00%
+Mistakes: No words typed wrongly.
+```
+### 3.6 Saving the data
+Typists automatically stores the game records (and any changes to them) into text files.
+
+
+### !Warning: Editing the data file
+Typists is a game application and only game records will be stored.
+Gamers should not edit the data it will manipulate the integrity of the records.
+In the event where the data is edited and the wrong format is inputted, the file contents will be cleared,
+hence losing all the game data.
+
+### 3.7 Man Pages: `man`
+
+Review the man pages for different command if you need help.
+Format: `man [COMMAND]`
+* `man` with out specifying the command will display the default man page.
+
+Example: `man clear`
+```
+ | Clear all past game records.
+ | Command format: clear [-g GAME_MODE] [-h]
+```
## FAQ
**Q**: How do I transfer my data to another computer?
-**A**: {your answer here}
+**A**: Copy and paste the save data under the same working directory.
-## Command Summary
+**Q**: The wiki page contains error messages. What should I do?
+
+**A**: Some characters might not be supported by the CLI. You can search for another page as an alternative.
-{Give a 'cheat sheet' of commands here}
+**Q**: Why does the time limit need to be a multiple of 30?
+
+**A**: It's a design choice. You can select the word limit game if you find it too restricting.
+
+
+## Command Summary
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+| Command | Action |
+| ------------- | ------------- |
+|`content`| Set the content
+|`game -word [WORD_LIMIT] [-sn] [-c]` | Start a word-limited game
+|`game -time [TIME_LIMIT] [-sn] [-c]` | Start a time-limited game
+|`history -g GAME_MODE [-n NUMBER_OF_RECORDS] [-h]` | View past game records
+|`clear [-g GAME_MODE] [-h]` | Clear past game records
+|`man [COMMAND]`| View man pages of command
+|`bye`| Exit the program
diff --git a/docs/_config.yml b/docs/_config.yml
new file mode 100644
index 0000000000..c4192631f2
--- /dev/null
+++ b/docs/_config.yml
@@ -0,0 +1 @@
+theme: jekyll-theme-cayman
\ No newline at end of file
diff --git a/docs/diagrams/TimeGame_SequenceDiagram.puml b/docs/diagrams/TimeGame_SequenceDiagram.puml
new file mode 100644
index 0000000000..a128843e20
--- /dev/null
+++ b/docs/diagrams/TimeGame_SequenceDiagram.puml
@@ -0,0 +1,66 @@
+@startuml
+
+box TimeLimitGame
+participant ":TimeLimitGame" as game
+participant "ui:GameUi" as ui
+endBox
+participant ":Util" as util
+participant "in:Scanner" as scanner
+
+[-> game: runGame()
+activate game
+
+create scanner
+game --> scanner: <