[CS2113-T13-4] TypingGame

build.gradle

@@ -10,6 +10,7 @@ repositories {
 }
 
 dependencies {
+    implementation 'org.fastily:jwiki:1.8.0'
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
 }
@@ -29,11 +30,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.typists.Main"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "typists"
     archiveClassifier = null
 }
 
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -2,8 +2,7 @@
 
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+<img src="https://www.designyourway.net/blog/wp-content/uploads/2017/03/Anime-Wallpaper-Desktop-Background-29-1250x834.jpg" width="100" height="100"> | Lim Jia Jing | [Github](https://github.com/LimJiaJing) | [Portfolio](docs/team/limjiajing.md)
+<img src="https://user-images.githubusercontent.com/69776265/136035789-60431999-0190-4967-948f-e936065e8275.png" width="100" height="100"> | Lu Sicheng | [Github](https://github.com/Isabella-L) | [Portfolio](docs/team/lusicheng.md)
+<img src="https://user-images.githubusercontent.com/71874189/136139996-ba992a28-d026-49ca-b134-ee8213411d93.jpg" width="100" height="100">| Shi Zhansen | [Github](https://github.com/DuckWillow) | [Portfolio](docs/team/shizhansen.md)
+<img src="https://avatars.githubusercontent.com/u/58932649?v=4" width="100" height="100">| William Wahyudi | [Github](https://github.com/maxwireddevs) | [Portfolio](docs/team/williamwahyudi.md)

docs/DeveloperGuide.md

@@ -1,15 +1,41 @@
 # Developer Guide
 
+* [Acknoledgements](#acknowledgements)
+
 ## Acknowledgements
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+* https://www.baeldung.com/java-testing-system-out-println
+
+##Architecture
+
+(Some architecture diagram)
 
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### Choose game mode
+
+### Choose the game content
+
+### Word Limit Game
+
+Once the CommandFactory reads a 'word' command, a word limit game will begin.
+
+Gonna to change this .puml diagram later - zhansen
+
+![](uml/WordLimitMode.png)
+
+### Time Limit Game
+
+### Storage
 
 ## 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}
@@ -28,6 +54,8 @@
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
+### Animation
+
 
 ## Glossary
 

docs/UserGuide.md

@@ -11,24 +11,57 @@
 1. Ensure that you have Java 11 or above installed.
 1. Down the latest version of `Duke` from [here](http://link.to/duke).
 
-## Features 
+## Features
+### Usage
+### Open Game
 
-{Give detailed description of each feature}
+### {Feature name}: {`Keyword`}
+Description of feature  
+Format: {format of command}
+* Explanation 1 of format
+* Explanation 2 of format
+<!-- -->
+Examples
+* command example 1
+* command example 2
+<!-- -->
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+### `Keyword` - Describe action
 
-Example of usage: 
+List of the keywords are shown below:
 
-`todo n/Write the rest of the User Guide d/next week`
+`content`-Set the content
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+`new`-Enter a word-limited game mode
 
+>Exit word-limited game mode command: `Exit`
+
+`time`-Enter a time-limited game mode
+
+`error`-Enter a error detecting game mode
+
+`bye`-Exit the program.
+
+### Showing summary of a game
+Statistics of game is shown automatically after a game is finished.
+
+## Example of usage:
+
+>`new`
+```
+| Enter how many words you want the game to run: 
+```
+>`12`
+```
+lorem ipsum is simply dummy
+```
+>`lorem ipsum is simply dummy`
+```
+Your progress:5/12
+text of the printing and
+```
 ## FAQ
 
 **Q**: How do I transfer my data to another computer? 

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-hacker

docs/team/limjiajing.md

@@ -0,0 +1,6 @@
+# Lim Jia Jing - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions

docs/team/lusicheng.md

@@ -0,0 +1,6 @@
+# Lu Sicheng - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions

docs/team/shizhansen.md

@@ -0,0 +1,7 @@
+# Shi Zhansen - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions
+

docs/uml/WordLimitMode.puml

@@ -0,0 +1,69 @@
+@startuml
+
+[-> SearchCommand : execute()
+activate SearchCommand
+
+alt Able to connect
+    SearchCommand -> NusMods : searchModsOnline()
+    activate NusMods
+    NusMods -> NusMods : getOnlineModList()
+    activate NusMods
+    NusMods --> NusMods
+    deactivate NusMods
+    loop for each mod
+            alt Module Code Match
+                    NusMods -> NusMods : fetchModOnline()
+                    activate NusMods
+                    NusMods -> NusMods : getOnlineModInfo()
+                    activate NusMods
+                    NusMods --> NusMods
+                    deactivate NusMods
+                    NusMods -> ModStorage : saveModInfo()
+                    activate ModStorage
+                    ModStorage --> NusMods
+                    deactivate ModStorage
+                    NusMods -> ModStorage : loadModInfo()
+                    activate ModStorage
+                    ModStorage --> NusMods
+                    deactivate ModStorage
+                    deactivate NusMods
+                alt All Flags Match
+                    NusMods -> TextUI : PrintModBriefDescription()
+                    activate TextUI
+                    TextUI --> NusMods
+                    deactivate TextUI
+                else
+                end
+            else
+            end
+    end
+    NusMods --> SearchCommand
+    deactivate NusMods
+
+else No connection or Quicksearch
+
+    SearchCommand -> ModStorage : searchFiles()
+    activate ModStorage
+    loop for each json
+        alt Module Code Match
+            ModStorage -> ModStorage : loadModInfo()
+            activate ModStorage
+            ModStorage --> ModStorage
+            deactivate ModStorage
+            alt All Flags Match
+                ModStorage -> TextUI : PrintModBriefDescription()
+                activate TextUI
+                TextUI --> ModStorage
+                deactivate TextUI
+            end
+        end
+    end
+    ModStorage --> SearchCommand
+    deactivate ModStorage
+
+end
+
+<-- SearchCommand
+deactivate SearchCommand
+
+@enduml

seedu.typists.ui.TextUi.log

@@ -0,0 +1,4 @@
+
+Oct 26, 2021 11:21:51 PM seedu.typists.ui.SummaryUi setUpLog
+
+INFO: Set up log in TextUi

src/main/java/seedu/typists/Main.java

@@ -0,0 +1,73 @@
+package seedu.typists;
+
+import seedu.typists.content.Content;
+import seedu.typists.command.Command;
+import seedu.typists.command.CommandFactory;
+import seedu.typists.ui.TextUi;
+
+import seedu.typists.storage.Storage;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Scanner;
+
+
+public class Main {
+    /**
+     * Version info of the program.
+     */
+    public static final String VERSION = "Typist - Version 1.0";
+    public static final int LINE_LENGTH = 10;
+    public static Content content;
+    public static TextUi uiBot;
+    Storage storage;
+
+
+    public Main() {
+        uiBot = new TextUi();
+        this.storage = new Storage();
+        content = new Content();
+    }
+
+    public void start() {
+        uiBot.showWelcomeMessage(VERSION);
+    }
+
+    public String read() {
+        Scanner sc = new Scanner(System.in);
+        return sc.nextLine();
+    }
+
+    public void runCommandLoop() {
+        CommandFactory cmdFactory = new CommandFactory();
+        String command;
+        ArrayList<String> args;
+        do {
+            String[] input = read().split(" ");
+            command = input[0];
+            args = new ArrayList<String>(Arrays.asList(Arrays.copyOfRange(input,1,input.length)));
+            Command c = cmdFactory.getCommand(input[0]);
+            if (c != null) {
+                c.run(args);
+            }
+        } while (!command.equals("bye"));
+    }
+
+    public void exit() {
+    }
+
+    /**
+     * Runs the program until termination.
+     */
+    public void run() {
+        start();
+        runCommandLoop();
+    }
+
+    /**
+     * Main entry-point for the java.duke.Duke application.
+     */
+    public static void main(String[] args) {
+        new Main().run();
+    }
+}

src/main/java/seedu/typists/command/Command.java

@@ -0,0 +1,7 @@
+package seedu.typists.command;
+
+import java.util.ArrayList;
+
+public interface Command {
+    void run(ArrayList<String> args);
+}

src/main/java/seedu/typists/command/CommandFactory.java

@@ -0,0 +1,25 @@
+package seedu.typists.command;
+
+import seedu.typists.ui.TextUi;
+
+public class CommandFactory {
+    TextUi ui = new TextUi();
+
+    public Command getCommand(String commandType) {
+        switch (commandType) {
+        case "time":
+            return new TimeGameCommand();
+        case "word":
+            return new WordGameCommand();
+        case "content":
+            return new ContentCommand();
+        case "error":
+            return new ErrorCommand();
+        case "bye":
+            return new ExitCommand();
+        default:
+            ui.printScreen("invalid command");
+            return null;
+        }
+    }
+}