General Items Lab 4 - shawyer/battleships GitHub Wiki

List of Functional Issues

  • Clicking on a coordinate where we want to place the ship after selecting the ship.
    • The ship gets placed 3-4 squares below the mouse click position.
  • Clicking the arrow when a certain ship is selected.
    • It's unclear what the arrow is actually for.
  • The game can't be run on a certain device.
  • When compiling, the Siren.wav file isn't found.

List of files description

Resources folder contains all the required resources for the battleship program

  • Animations - This animation file contains the splash and explosion animation
  • Bundles - This loads all of the resourced used by the splash screen, images for files and folders
  • Fonts - Contains all the required fonts for the battleship program
  • Images - Contains all the required images for the battleship program
  • Sounds - Contains all the required sounds for the battleship program
  • SwinGame.icns - This is the swinburne icons file format specifically for mac user
  • SwinGame.ico - This is the swinburne icons file format for windows user
  • Highscores.txt - Contains the high scores for players.

Codes/Resources not being used

Siren.wav audio file is not being used

In the compiling process, the Siren.wav is not found. Moreover, in GameResources.vb it mentions all the sound effect that will be used, it does mention the Siren.wav, but there is no such file is found in the resources/sounds folder. Therefore, the Siren.wav must not being used or needed.

List of Conversion Tools

Extension Ideas

  • Let user choose between different continent (e.g. Indian Ocean, Arctic Ocean...)
  • Make the main menu option become more visible
  • Allow the players to play in full-screen
  • Label all the ships with an interesting name
  • Add a pause and resume button
  • Add an option to go back to main menu

Existing documentation

We went through the entire code base and find that most of them are well documented. Above the class code, they provide a brief description of what will the classes do and that really is helpful for those who are working on the project in case there are new members or they happened to forget what the classes is for. However, we also find that some of the code base are lack of documentations, for example the "GameResources.vb", not a single brief description is found.

Meeting Minutes 1

Date/Location: 28-08-2019, EN310

Attendees: Daniel Shawyer, Indra Kusuma, Kimhong Lay

Start Time: 8.30

End Time: 9.30

Decisions

  • Kimhong will be responsible to create the Trello board and inviting the rest of the team members.
  • Kimhong will be responsible to create Toogl team project and inviting the rest of the team members.
  • Daniel will be responsible for adding the VB.Net code base to github.
  • Daniel will be responsible for researching the tools that will be used to convert VB code to C# code.
  • Indra will be responsible for researching a suitable coding standard to be used for the project.
  • Indra will be responsible for making a complete list of files with detailed description in assets.
  • All of the team members will responsible to identify obvious TODO, BUG, or FIXME comments.
  • Kimhong and Indra will be responsible for doing D8 Task

Actions

  • Trello board and Toogl has been created and all the team members are invited including the tutor.
  • Decided that Telerik will be used as the tools to convert the VB code to C#.
  • Adding the VB.Net base code to github and research the tools that will be used to convert the VB.Net code to C#.
  • A list of coding standard has been listed.
  • Include a detailed description to each and every assets in wiki.
  • Going through the entire code base to identify TODO, BUG, and FIXME comments.
  • List any function issues in the program and the codes/resources that aren't needed in the program.
  • Adding a list of extension ideas that might be able to make the game more interesting.