TOURNAMENT BASED TIGER ZONE

This is a game rendition inspired and based on the popular board game known as Carcassonne by Klaus-Jurgen Wrede. It is in accordance with the "term" project for Introduction to Software Engineering (CEN3031), taught by Dave Small at the University of Florida. The intention is to have a working game capable of having two players, capable of implementing an Artificial Intelligence, and capable of communicating with a tournament server to compete against the rest of the class' implementations.

Any and all design documents procured during the course of this project have been placed inside of the /documentation/ subdirectory. Some are deprecated, and may have been changed since first implemented. The source code provides a much more in depth commentary and structure, and is the most up to date.

Any and all current source code have been placed inside of /src/.

Any and all resources have been placed inside of /resources/. This mainly contains XML formatted information to generate our tiles via a factory design pattern.

TEAM INFORMATION

COURSE: CEN3031
TEAM: E
MEMBERS:

• Matthew Booe - mirdaki
• Charley Chau - charleychau
• Josiah Crepeau - crepeau
• Tana Konda - TanaKonda
• Connor Ward - conward
• Zak Mills - N/A

OVERALL ARCHITECTURAL STRUCTURE

There are three main architectural systems, each maintaing sub systems integral to the overall design. There is also two additional systems to handle unit testing (through JUnit) and acceptance testing (FITNesse).

The three main architectural systems, alongside their relevant entities and value objects are as follows:

• Tournament Network Handler: instantiates two games and communicates between the tournament server and the game

  • TigerZoneClient
  • TigerZoneServer (own implementation test)

• Entities:

  • BoardObject: handles the board
  • AI: artificial intelligence system that creates
  • Terrain: individual terrains specific to a tile
    • DenTerrain
    • LakeTerrain
    • JungleTerrain
    • TrailTerrain
  • Region: contains all board regions
    • DenRegion
    • LakeRegion
    • JungleRegion
    • TrailRegion
  • TileStack: generates our tiles
    • TileObject
      • TigerTile
      • TileEdges
      • TilePair
  • TileDeck: maintains deck (and can generate randomly)
  • Player
  • TigerObject
  • CrocodileObject
  • Animal

• Game: integrates all of our entity objects and provides communication medium between server

• Tests: all JUnits and FITNesse fixture code

GAME INTERACTION OUTLINE

This is the outline for the interactions of the game

1. TigerZoneClient connects to server
   • Logs in, waits for challenge
2. TigerZoneClient creates 2 new Game for each round
   • Starts counter, passes game ID and tile stack
3. TigerZoneClient receives tile to place, passes to Game
   • Game passes tile to AI
   • AI decides on tile and meeple placement
     • AI looks at possible values from valid tiles
     • AI adds tile to board
   • Game receives AI decision and sends that to TigerZoneClient
4. TigerZoneClient receives move information, passes to Game
   • Game adds other players tile to BoardObject
   • Passes if player passes
   • Game adds any meeples to tile
   • Increments in TigerZoneClient and Game
5. Repeat 3 and 4 until end of round and clear Games
6. TigerZoneClient ends on end game signal

COMPILATION

In order to compile our code, run from the src folder:

javac game/*.java entities/*.java network/*.java

In order to compile our tests, see below.
NOTE: If you do not use Eclipse to compile and run the code, you will have to change the filepath in TileDeck and TigerTile from

TileDeck Line 43: File file = new File("resources/tiles.xml");

to

File file = new File("../resources/tiles.xml");

and likewise on

TigerTile Line 153

RUN

In order to run our network implementation, from the root folder:

java network/TigerZoneClient

In order to run our game client, from the root folder:

java game/Game

TESTS

JUnit:
The files in src/tests are JUnit tests designed to test the methods of each entity in our system. All JUnit tests were made in Eclipse and can be run in Eclipse, similar to any other JUnit test files. The test code can be built and compiled in the same way as the client. The tests can then be run by pressing CTRL+F11 or clicking Run in the top navigation bar. You can run all tests at once by highlighting the tests package in the package explorer and then running, or you can run one test at a time by highlighting the desired JUnit test and running it.

##Running Tests via Command Line in Windows In order to run the JUnit tests via command line, you will first have to download JUnit. That can be done here: https://sourceforge.net/projects/junit/files/junit/4.10/

After downloading the JUnit .jar, place it in whichever directory you would like. One example would be C:\JUNIT. After placing the .jar here, open your command prompt and set the JUnit environment. If your JUnit directory was C:\JUNIT, this can be done by the following command:

set JUNIT_HOME=C:\JUNIT

Replace C:\JUNIT with the directory you chose earlier if needed. Next, set the CLASSPATH variable by using the following command:

set CLASSPATH=%CLASSPATH%;%JUNIT_HOME%\junit-4.10.jar;.;

Now, move the test files to the entities directory of our project. Navigate to the src directory. Compile the code by running the following command:

javac entities/*.java

Now run the desired test file by changing the name of the designated test file in the TestRunner.java class. This is found in line 9. It is pointing to AnimalTest.class by default. You may have to recompile the TestRunner.java file each time something is changed in the .java file. In order to run the desired test, use the following command:

java entities/TestRunner

More information, like how to run these tests in Linux or Mac, can be found here: https://www.tutorialspoint.com/junit/junit_environment_setup.htm