[W14-3] Battleship

.gitignore

@@ -18,3 +18,5 @@ classes/
 /bin/
 src/main/resources/docs/
 out/
+.backup/
+docs/diagrams/.~lock*

README.adoc

@@ -1,10 +1,16 @@
-= Address Book (Level 4)
+= Battleship
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
+https://travis-ci.org/CS2103-AY1819S2-W14-3/main[image:https://travis-ci.org/CS2103-AY1819S2-W14-3/main.svg?branch=master[Build Status]]
+https://github.com/CS2103-AY1819S2-W14-3/main[image:https://travis-ci.org/CS2103-AY1819S2-W14-3/main.svg?branch=master[Build Status]]
+https://coveralls.io/github/CS2103-AY1819S2-W14-3/main[image:https://coveralls.io/repos/github/CS2103-AY1819S2-W14-3/main/badge.svg?branch=master[Coverage Status]]
+
+
+ifdef::sdsdds[]
+
 https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
 https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
+endif::[]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -14,26 +20,23 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
+* This is a desktop Battleship application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+* One can play the classic Battleship game against the computer on this app.
+* This application is designed for people who want to play Battleship but prefer to use the command-line or are otherwise unable to operate a GUI.
+** This project is written in an OOP style.
+** This project supports _Build Automation_ using Gradle and _Continuous Integration_ using Travis CI.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
-* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
-_Marco Jakob_.
+* This application is a fork of https://github.com/nus-cs2103-AY1819S2/[addressbook-level4] by
+the se-edu team.
 * Libraries used: https://github.com/TestFX/TestFX[TextFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
 
 == Licence : link:LICENSE[MIT]

_reposense/config.json

@@ -0,0 +1,30 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "bos10",
+      "displayName": "CHE...TON",
+      "authorNames": ["bos10"]
+    },
+    {
+      "githubId": "s-tr",
+      "displayName": "CHO...WEI",
+      "authorNames": ["s-tr"]
+    },
+    {
+      "githubId": "iwle",
+      "displayName": "IAN... EN",
+      "authorNames": ["iwle", "Ian Wu", "[email protected]"]
+    },
+    {
+      "githubId": "lucydotc",
+      "displayName": "LUC...YAN",
+      "authorNames": ["lucydotc"]
+    },
+    {
+      "githubId": "erjillsison",
+      "displayName": "SIS...NES",
+      "authorNames": ["erjillsison"]
+    }
+  ]
+}

build.gradle

@@ -77,7 +77,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'battleship.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -202,8 +202,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
+        'site-name': 'Battleship',
+        'site-githuburl': 'https://github.com/CS2103-AY1819S2-W14-3/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

docs/AboutUs.adoc

@@ -4,53 +4,53 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
-We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
+Battleship was developed by Team W14-G3. We are a team from Singapore developing retro games for the world. +
+
+We are based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== Boston Cheong
+image::bos10.png[width="150", align="left"]
+{empty}[https://github.com/bos10[github]] [<<bos10#, portfolio>>]
 
-Role: Project Advisor
+Role: Developer +
+Responsibility: Statistics management feature
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Erjill Sison
+image::erjillsison.png[width="150", align="left"]
+{empty}[http://github.com/erjillsison[github]] [<<erjillsison#, portfolio>>]
 
 Role: Team Lead +
-Responsibilities: UI
+Responsibilities: Map management feature
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Esther Chong
+image::s-tr.png[width="150", align="left"]
+{empty}[http://github.com/s-tr[github]] [<<s-tr#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: Battle management feature
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Ian Wu
+image::iwle.png[width="150", align="left"]
+{empty}[http://github.com/iwle[github]] [<<iwle#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Ship management feature
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Lucy Chan
+image::lucydotc.png[width="150", align="left"]
+{empty}[http://github.com/lucydotc[github]] [<<lucydotc#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Computer Enemy management feature
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/CS2103-AY1819S2-W14-3/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
 * *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+* *Email us* : You can also reach us at `battleshipdevelopers [at] gmail.com`