README.md 1.64 KB
Newer Older
Ian Charles's avatar
Ian Charles committed
1
# Battleship
Ian Charles's avatar
Ian Charles committed
2

Ian Charles's avatar
Ian Charles committed
3
## Group information:
Thomas Stone's avatar
Thomas Stone committed
4

Ian Charles's avatar
Ian Charles committed
5
6
7
8
9
10
11
12
13
14
15
16
#### Team Name:

0x4256 Stones

#### Team Members:

Mateo Conde, Thomas Stone,  Oscar Giller, Ian Charles

## Project Overview:

#### Package Structure:

Oscar Giller's avatar
Oscar Giller committed
17
We have a Battleship, GameDriver, Server, and a ShipPlacement package in our src file. This package structure allows us to organize the different classes which is especially helpful with all of the different MVC style files we have.
Ian Charles's avatar
Ian Charles committed
18
19
20
21
22
23
24

#### Project Description:

This is the culminating project for the CSCI205 class at Bucknell University. The purpose of this project is to create a deliverable that teaches good coding practices and use of the Scrum design process. 

The goal of this project is to create a user-friendly java-based version of the classic board game Battleship. The project features an intuitive GUI and both multiplayer and singleplayer capabilities. Single player mode allows you to choose from different computer opponents programmed for different difficulties. Alternatively, the multiplayer option allows two users to play on one system, passing control back and forth as the turn alternates. 

Thomas Stone's avatar
Thomas Stone committed
25
Our GUI is set up to be reminiscent of the Battleship board game we grew up with and loved. It features the classic look with the opponent’s board sitting over your’s and has all of the statistics and options on the side.
Ian Charles's avatar
Ian Charles committed
26
27
28
29
30
31
32
33
34

### Libraries:

JavaFX 15

JUnit 5.5.2 

## Build/Run instructions:

Mateo Conde's avatar
Mateo Conde committed
35
36
37
The program can be run by issuing the following command
  
```
Mateo Conde's avatar
Mateo Conde committed
38
    java --module-path <path-to-lib>/javafx-sdk-14/lib --add-modules=javafx.controls -jar dist/csci205_project.jar
Mateo Conde's avatar
Mateo Conde committed
39
40
41
```

The program is compiled through the “GameDriver.java” file in the “src” folder.