Skip to content

Commit

Permalink
Updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nazalan committed May 20, 2024
1 parent 994f8a7 commit da2b19c
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/ManualUI.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,22 @@ After the initial testing, we discovered 5 major issues that needed fixing.

Input values were added to a list without validation, with no restrictions on characters. To fix this, we updated the function that handles input parameters to only accept allowed names. The updated function restricts inputs to only include lowercase and uppercase letters (A-Z) and numbers, excluding whitespace.

image::typeError.png[width=300, height=200]
image::typeError.png[width=200, height=200]

== Field widths

There were no restrictions on the length of input values (player name), allowing names of any length to be added to the player list. To fix this, we introduced an additional check to ensure that player names can be a maximum of 10 characters long.

image::unlimitedChars.png[width=300, height=200]
image::unlimitedChars.png[width=200, height=200]

== Navigational elements

During application runtime, there was no option to exit because it used full-screen mode without an exit or close button. To implement an exit option, we created a CloseButton class, accessible from the main menu and during gameplay, allowing the application to be closed at any time.

image::exitInMenu.png[width=300, height=200]

image::exitGame.png[width=300, height=200]

== Error logging

The application did not properly log information or errors. To fix this, we introduced Loggers using the _java.util.logging.Logger_ class, which logs all significant events. Several classes were modified to incorporate this logging functionality.
Expand All @@ -30,6 +34,8 @@ The application did not properly log information or errors. To fix this, we intr

In the main menu, the _Start_ button was always clickable, even when no map was selected or there weren't enough players. Instructions for the user were unclear about what needed to be completed to start the game. To improve clarity in user interaction, the _Start_ button in the main menu is now only clickable when the conditions required to start the game are met (map selected, sufficient players).

image::waiting.png[alt="Waiting for a player",width=300, height=200]

== Summary

The user interface is a critical aspect of the application. In our application, there were no security risks, and the goal was merely to enhance the user experience. Finding the issues is easy, but often it is challenging to determine how to fix them.
Binary file added doc/exitGame.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/exitInMenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/unlimitedChars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/waiting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit da2b19c

Please sign in to comment.