A new version of cs56-games-client-server that is identical on the outside, but substantially refactored inside to have better MVC separation.
Yiyang Xu, Nikki Tyagi, link to the javadoc: https://meredithxu.github.io/cs56-games-gomoku/javadoc
CS56, F16: Madhu Kannan, Colin Garrett
Two player game where to win you need to place five of your own markers in a row. Players take turns placing markers down one at a time.
Code currently contains two versions, an older one that has all classes and methods in a single file, as well as a second version that splits the game into three classes: Gomoku, Controller, and Viewer. Gomoku contains the bulk of the code that sets up the gameplay including tokens and checks for winners. Controller deals with mouse events. Viewer establishes the user interface by creating a JFrame and other graphics components.
In its current state, the execution of game principles works perfectly, but there are a number of other issues. For example, when somebody wins, although this is detected, a winning message is printed infinitely to the screen. There are no graphical components for a homescreen, endscreen, or instructions. Also, there are no tests at all. We plan to address these issues and add JUnit tests.
F16 final remarks:
Currently, a vast majority of the code is in Gomoku.java. However, the program starts in Viewer.java, where the homescreen is launched. From the home screen, you can check a box that alters the game mode, read instructions, and launch the game. The game is a 19x19 grid of tiles. Clicks alternate between placing green tiles and placing blue tiles. In standard gomoku, there must be exactly 5 tiles (i.e. ==5) of one color in a row for there to be a win. In freestyle gomoku, there must be at least 5 tiles (i.e. >=5) of one color in a row for there to be a win. When a player/color wins, a window with the option to either play again or return to the homescreen appears. This window also announces the winner of the game. Clicking either will close this window and the game window, and additionally open a new game board window if the user decided to play again.
When we received this project, running the program opened the game board directly and there was no way to play again after winning. We added a home screen, a play again screen, instructions, and a way to see whose turn is next. In addition, we added JUnit tests. Because we added all of these from scratch they are all very basic. There is a lot of potential for the screens we added to look nicer and for the JUnit tests to be more rigorous. An example of one possible improvement would be for the graphics elements on the board to be part of some sort of border layout. Currently, the game tiles and the text that tells the user whose turn it is are simply painted onto the panel, which makes modifications more difficult.
F17 Final Remarks:
When we first looked at this project, we encountered trouble compiling the code, and ran into a number of checking for win bugs that previous groups did not find. The code originally opened new windows for playing a game and instructions and we changed the code so that it now uses CardLayout to decide the current frame as well as moving these JPanels into different classes. The code has been refactored quite a bit so that it is easier to understand the usage of classes, but there continues to be some tight coupling that may need to be fixed. For instance, there is some interdepency with Viewer.java dependent on HomePanel.java and HomePanel.java dependent on Viewer.java. There is a new picture for the game screen (unfortunately hard coded) and on the home screen. The game screen may need to be separated into a new layout manager. (Currently, values are hard coded making it difficult to change the UI of the game.)
Other new things that can be added: Gomoku has other styles of play beyond normal Gomoku. Technically, normal Gomoku only wins with exactly five-in-a-row, but currently, players can still win by attaining six-in-a-row or more. Only Freestyle Gomoku should allow that option. There are a number of house rules that can still be implemented to make the game more interesting. (Look up in Wikipedia for more information about other rules.)
Potential Issues: Remove some interdependecies between classes, for instance between Viewer.java and HomeScreen.java Fix the clicking so that it requires only one click to place a stone. (Most of the time I have to click twice to confirm a stone.) Add a layout manager to Gomoku.java so that the UI is more flexible.