[CS2113-T18-1] ChessMaster

.github/workflows/gradle.yml

@@ -33,18 +33,18 @@ jobs:
       - name: Build and check with Gradle
         run: ./gradlew check
 
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat
+      # - name: Perform IO redirection test (*NIX)
+      #   if: runner.os == 'Linux'
+      #   working-directory:  ${{ github.workspace }}/text-ui-test
+      #   run: ./runtest.sh
+
+      # - name: Perform IO redirection test (MacOS)
+      #   if: always() && runner.os == 'macOS'
+      #   working-directory:  ${{ github.workspace }}/text-ui-test
+      #   run: ./runtest.sh
+
+      # - name: Perform IO redirection test (Windows)
+      #   if: always() && runner.os == 'Windows'
+      #   working-directory:  ${{ github.workspace }}/text-ui-test
+      #   shell: cmd
+      #   run: runtest.bat

.gitignore

@@ -8,10 +8,13 @@
 /build/
 src/main/resources/docs/
 
+.vscode
+
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml
 bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+data/

CONTRIBUTORS.md

@@ -1,9 +1,13 @@
 # Contributors
 
-Display | Name | Github Profile | Homepage
----|:---:|:---:|:---:
-![](https://avatars0.githubusercontent.com/u/22460123?s=100) | Jeffry Lum | [Github](https://github.com/j-lum/) | [Homepage](https://se.kasugano.moe)
-![](https://avatars0.githubusercontent.com/u/1673303?s=100) | Damith C. Rajapakse | [Github](https://github.com/damithc/) | [Homepage](https://www.comp.nus.edu.sg/~damithch/)
+Name | Github Profile
+---|:---:
+Antriksh Dhand | [Github](https://github.com/antrikshdhand/)
+Ou Ningxiang | [Github](https://github.com/onx001/)
+Oh Ken Wei | [Github](https://github.com/ken-ruster/)
+Tong Zheng Hong | [Github](https://://github.com/TongZhengHong/)
+Tricia Boo Koh | [Github](https://://github.com/TriciaBK/)
 # I would like to join this list. How can I help the project
 
-For more information, please refer to our [contributor's guide](https://oss-generic.github.io/process/).
+
+For more information, please refer to our [contributor's guide](README.md#contributing).

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: chessmaster.ChessMaster
+

README.md

@@ -1,64 +1,100 @@
-# Duke project template
-
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
-
-1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
-1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
-   ```
-   > Task :compileJava
-   > Task :processResources NO-SOURCE
-   > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
-   ```
-   Type some word and press enter to let the execution proceed to the end.
-
-## Build automation using Gradle
-
-* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file).
-* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html).
-
-## Testing
-
-### I/O redirection tests
-
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
-
-### JUnit tests
-
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
-* If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
-
-## Checkstyle
-
-* A sample CheckStyle rule configuration is provided in this project.
-* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html).
-
-## CI using GitHub Actions
-
-The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.
-
-## Documentation
-
-`/docs` folder contains a skeleton version of the project documentation.
-
-Steps for publishing documentation to the public: 
-1. If you are using this project template for an individual project, go your fork on GitHub.<br>
-   If you are using this project template for a team project, go to the team fork on GitHub.
-1. Click on the `settings` tab.
-1. Scroll down to the `GitHub Pages` section.
-1. Set the `source` as `master branch /docs folder`.
-1. Optionally, use the `choose a theme` button to choose a theme for your documentation.
+ <br />
+ <div align="center">
+    <a href="">
+        <img src="docs/images/ChessMasterLogo.png" alt="Logo" width="80" height="80">
+    </a>
+    <h3 align="center">ChessMaster</h3>
+    <p align="center">
+        Chess finally makes it to your terminal.
+        <br />
+        <a href="https://ay2324s1-cs2113-t18-1.github.io/tp/UserGuide.html">View User Guide</a>
+        ·
+        <a href="https://ay2324s1-cs2113-t18-1.github.io/tp/DeveloperGuide.html">View Developer Guide</a>
+        ·
+        <a href="https://ay2324s1-cs2113-t18-1.github.io/tp/AboutUs.html">About Us</a>
+    </p>
+ </div>
+
+_ChessMaster_ is a command-line interface (CLI) chess game designed to make learning and training accessible for
+beginners while offering an engaging experience for all skill levels. This simple and user-friendly chess simulator
+provides a platform for novice players to build their skills and understanding of the game.
+
+This project was created for the _CS2113: Software Engineering and Object-Oriented Programming_ team project and
+is programmed in 100% Java.
+
+## Getting started
+
+1. Ensure you have **Java 11 or above** installed in your system.
+
+2. Download the latest version of `ChessMaster.jar` from [here](https://github.com/AY2324S1-CS2113-T18-1/tp/releases).
+
+3. Open a terminal instance and navigate into the folder that contains the downloaded ChessMaster.jar file.
+
+```bash
+cd PATH_TO_JAR_FILE
+```
+
+4. Run the jar application with the following command:
+
+```bash
+java -jar ChessMaster.jar
+```
+
+You should be greeted by a welcome message from ChessMaster:
+```
+_________________________________________________________________
+
+Hey there, chess geek! You have stumbled upon the one and only:
+    ________                      __  ___           __
+   / ____/ /_  ___  __________   /  |/  /___ ______/ /____  _____
+  / /   / __ \/ _ \/ ___/ ___/  / /|_/ / __ `/ ___/ __/ _ \/ ___/
+ / /___/ / / /  __(__  |__  )  / /  / / /_/ (__  ) /_/  __/ /
+ \____/_/ /_/\___/____/____/  /_/  /_/\__,_/____/\__/\___/_/
+
+where CHESS becomes an exciting journey of strategy and skill!
+_________________________________________________________________
+```
+
+## Usage
+
+A summary of user commands can be found in the table below:
+
+| Action        | Format                             |
+|---------------|------------------------------------|
+| Move          | `move [column][row] [column][row]` |
+| Show moves    | `moves [column][row]`              |
+| Show board    | `show`                             |
+| Rules         | `rules`                            |
+| Help          | `help`                             |
+| Pieces legend | `legend`                           |
+| History       | `history`                          |
+| Step back     | `stepback`                         |
+| List pieces   | `captured`                         |
+| Exit          | `exit`                             |
+
+Please visit our [User Guide](https://ay2324s1-cs2113-t18-1.github.io/tp/UserGuide.html) for further details on each 
+of these commands.
+
+## Contributing
+
+[![Contributors](https://img.shields.io/github/contributors/AY2324S1-CS2113-T18-1/tp?label=Contributors&style=flat-square)](https://github.com/AY2324S1-CS2113-T18-1/tp/graphs/contributors)
+[![Commits](https://img.shields.io/github/commits-since/AY2324S1-CS2113-T18-1/tp/latest?style=flat-square&label=Commits%20since%20v2.0)](https://github.com/AY2324S1-CS2113-T18-1/tp/commits/master)
+[![Issues](https://img.shields.io/github/issues/AY2324S1-CS2113-T18-1/tp?style=flat-square&label=Latest%20issues)](https://github.com/AY2324S1-CS2113-T18-1/tp/issues)
+[![PRs](https://img.shields.io/github/issues-pr/AY2324S1-CS2113-T18-1/tp?style=flat-square&label=Pull%20requests)](https://github.com/AY2324S1-CS2113-T18-1/tp/pulls)
+
+
+All contributions are greatly appreciated! If you have a suggestion that would make this better, 
+please fork the repo and create a pull request. 
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/branch-FeatureName`)
+3. Commit your Changes (`git commit -m 'Add some FeatureName'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## Contact
+
+Please visit our [About Us](https://ay2324s1-cs2113-t18-1.github.io/tp/AboutUs.html) page for further contact
+information.
+
+Project Link: [https://github.com/AY2324S1-CS2113-T18-1/tp](https://github.com/AY2324S1-CS2113-T18-1/tp)

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("chessmaster.ChessMaster")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("chessmaster")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,11 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
+}
+
+compileJava.options.encoding = 'UTF-8'
+
+tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
 }

build.xml

@@ -0,0 +1,35 @@
+<project name="ChessMaster" basedir="." default="main">
+
+    <property name="src.dir"     value="src/main/java"/>
+    <property name="build.dir"   value="build"/>
+    <property name="classes.dir" value="${build.dir}/classes"/>
+    <property name="jar.dir"     value="${build.dir}/jar"/>
+    <property name="main-class"  value="chessmaster.ChessMaster"/>
+
+    <target name="clean">
+        <delete dir="${build.dir}"/>
+    </target>
+
+    <target name="compile">
+        <mkdir dir="${classes.dir}"/>
+        <javac includeantruntime="false" target="11" source="11" encoding="utf8" srcdir="${src.dir}" destdir="${classes.dir}"/>
+    </target>
+
+    <target name="jar" depends="compile">
+        <mkdir dir="${jar.dir}"/>
+        <jar destfile="${jar.dir}/${ant.project.name}.jar" basedir="${classes.dir}">
+            <manifest>
+                <attribute name="Main-Class" value="${main-class}"/>
+            </manifest>
+        </jar>
+    </target>
+
+    <target name="run" depends="jar">
+        <java jar="${jar.dir}/${ant.project.name}.jar" fork="true"/>
+    </target>
+
+    <target name="clean-build" depends="clean,jar"/>
+
+    <target name="main" depends="clean,run"/>
+
+</project>

config/checkstyle/checkstyle.xml

@@ -242,6 +242,12 @@
             <property name="throwsIndent" value="8" />
         </module>
 
+        <module name="WhitespaceAround">
+            <property name="allowEmptyLambdas" value="true"/>
+            <property name="allowEmptyTypes" value="true"/>
+            <property name="allowEmptyMethods" value="true"/>
+        </module>
+
         <module name="NoWhitespaceBeforeCaseDefaultColon"/>
 
         <!--

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-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)
+| Name                                 | ID        | Github        |
+|--------------------------------------|-----------|---------------|
+| [Antriksh Dhand](team/antrikshdhand.md) | A0278458J | antrikshdhand |
+| [Oh Ken Wei](team/ken-ruster.md)     | A0251850J | ken-ruster    |
+| [Ou Ningxiang ](team/onx001.md)      | A0249445W | onx001        |
+| [Tong Zheng Hong](team/tongzhenghong.md) | A0251819Y | TongZhengHong |
+| [Tricia Boo Koh](team/triciabk.md)   | A0264665U | TriciaBK      |