0.0.6

Author: Project516

README.md

@@ -9,11 +9,17 @@ A simple number guessing game where you try to guess a randomly generated number
 For Debian/Ubuntu and derivatives (recommended for terminal usage):
 
 1. Download the `.deb` package from the [latest release](https://github.com/Project516/NumberGuessingGame/releases)
+
+   You can use curl to do it from the command line:
+   ```bash
+   curl -s -L -o numberguessingame.deb https://github.com/Project516/NumberGuessingGame/releases/download/0.0.x/numberguessinggame.deb
+   ```
+   where `x` is the version you want.
 2. Install it:
    ```bash
    sudo apt update # Update packages
-   sudo apt install ./numberguessinggame.deb # From directory the deb package is in
-   sudo apt install -f  # Install dependencies if needed
+   sudo apt install ./numberguessinggame.deb # From directory with the deb package
+   sudo apt install -f  # Install dependencies
    ```
 3. Run from anywhere in your terminal:
    ```bash
@@ -23,10 +29,13 @@ For Debian/Ubuntu and derivatives (recommended for terminal usage):
 To uninstall:
 ```bash
 sudo apt remove numberguessinggame
+sudo apt autoremove -y # Remove dependencies
 ```
 
 ### Manual Installation
 
+Download the `zip` archive from the [latest release](https://github.com/project516/numberguessinggame/releases)
+
 #### Requirements
 
 - Java 8 or higher (may require Java 17+ in future versions)

app/src/main/java/io/github/project516/NumberGuessingGame/CheckGuess.java

@@ -1,6 +1,16 @@
 package io.github.project516.NumberGuessingGame;
 
+/**
+ * Validates user guesses in the Number Guessing Game. This class ensures that user input falls
+ * within the acceptable range.
+ */
 public class CheckGuess {
+    /**
+     * Validates that a guess is within the acceptable range (1-100).
+     *
+     * @param guess the user's guess to validate
+     * @throws IllegalArgumentException if the guess is less than 1 or greater than 101
+     */
     void check(int guess) {
         if (guess < 1 || guess > 101) {
             throw new IllegalArgumentException("Invalid number!");

app/src/main/java/io/github/project516/NumberGuessingGame/DebugInfo.java

@@ -1,10 +1,21 @@
 package io.github.project516.NumberGuessingGame;
 
+/**
+ * Provides debugging information for the Number Guessing Game. This class displays system
+ * information and version details, and handles game crash notifications.
+ */
 public class DebugInfo {
 
+    /** System information provider. */
     SystemInfo sysInfo = new SystemInfo();
+
+    /** Version file reader. */
     ReadVersionFile vFile = new ReadVersionFile();
 
+    /**
+     * Displays debug information including Java version, vendor, JDK name, and game version to the
+     * console.
+     */
     void launchDebug() {
         System.out.println("\n===== DEBUG INFO =====\n\n");
         System.out.println("Java version: " + sysInfo.version());
@@ -14,6 +25,10 @@ void launchDebug() {
         System.out.println("\n\n======================\n\n");
     }
 
+    /**
+     * Displays a message when the game crashes. Called when an unexpected exception occurs during
+     * game execution.
+     */
     void gameCrash() {
         System.out.println("\n\n===Program Crashed!===\n\n");
     }

app/src/main/java/io/github/project516/NumberGuessingGame/GUI.java

@@ -5,7 +5,15 @@
 
 // TODO
 
+/**
+ * Graphical User Interface for the Number Guessing Game. This class creates and manages the game's
+ * window and UI components. Currently under development.
+ */
 public class GUI {
+    /**
+     * Creates and displays the main game window. Sets up a JFrame with a centered label showing the
+     * game title.
+     */
     void createWindow() {
         JFrame jframe = new JFrame("Number Guessing Game");
         JLabel jlabel = new JLabel("Number Guessing Game", SwingConstants.CENTER);
@@ -19,6 +27,11 @@ void createWindow() {
         jframe.setVisible(true); // Set visible
     }
 
+    /**
+     * Test method for the GUI. Creates a GUI instance and displays the window for testing purposes.
+     *
+     * @param args command line arguments (not used)
+     */
     public static void main(String[] args) { // Test GUI
         GUI GUI = new GUI();
         GUI.createWindow();

app/src/main/java/io/github/project516/NumberGuessingGame/GameInfo.java

@@ -1,19 +1,42 @@
 package io.github.project516.NumberGuessingGame;
 
+/**
+ * Provides information about the Number Guessing Game application. This class contains methods to
+ * display game information, author details, project URL, and online Javadoc location.
+ */
 public class GameInfo {
+    /**
+     * Displays information about the game to the console. Prints the game title and instructions
+     * for the player.
+     */
     void about() {
         System.out.println("This is a Number Guessing Game!");
         System.out.println("Guess a number between 1 and 100!\n");
     }
 
+    /**
+     * Returns the author of the Number Guessing Game.
+     *
+     * @return the author's username
+     */
     String author() {
         return "project516";
     }
 
+    /**
+     * Returns the project's GitHub repository URL.
+     *
+     * @return the GitHub project URL
+     */
     String projectURL() {
         return "https://github.com/project516/numberguessinggame";
     }
 
+    /**
+     * Returns the URL for the online Javadoc documentation.
+     *
+     * @return the online Javadoc URL
+     */
     String onlineJavadoc() {
         return "https://project516.github.io/NumberGuessingGame";
     }

app/src/main/java/io/github/project516/NumberGuessingGame/GameLogic.java

@@ -1,7 +1,15 @@
 package io.github.project516.NumberGuessingGame;
 
+/**
+ * Contains the main game logic for the Number Guessing Game. This class manages the game loop, user
+ * input, and guess validation.
+ */
 public class GameLogic {
     // TODO port game logic from Main to GameLogic
+    /**
+     * Runs the main game loop. Generates a random number and prompts the user to guess it. Provides
+     * feedback on each guess and tracks the number of attempts.
+     */
     void game() {
 
         RandomNumber ranNumber = new RandomNumber();

app/src/main/java/io/github/project516/NumberGuessingGame/Main.java

@@ -1,7 +1,17 @@
 package io.github.project516.NumberGuessingGame;
 
+/**
+ * Main entry point for the Number Guessing Game application. This class initializes the game
+ * components and starts the game.
+ */
 public class Main {
 
+    /**
+     * The main method that starts the Number Guessing Game. Initializes all necessary components,
+     * displays debug information, and runs the game logic with proper error handling.
+     *
+     * @param args command line arguments (not currently used)
+     */
     public static void main(String[] args) {
 
         ScannerHelper scan = new ScannerHelper();
@@ -19,7 +29,6 @@ public static void main(String[] args) {
         } catch (Exception e) {
 
             debugInfo.gameCrash();
-
             e.printStackTrace();
 
         } finally {

app/src/main/java/io/github/project516/NumberGuessingGame/RandomNumber.java

@@ -2,10 +2,21 @@
 
 import java.util.*;
 
+/**
+ * Generates random numbers for the Number Guessing Game. This class uses Java's Random class to
+ * generate random integers within a specified range.
+ */
 public class RandomNumber {
 
+    /** Random number generator instance. */
     Random random = new Random();
 
+    /**
+     * Generates a random integer between 0 and the specified maximum value (inclusive).
+     *
+     * @param max the maximum value for the random number
+     * @return a random integer between 0 and max (inclusive)
+     */
     int number(int max) {
 
         return random.nextInt(max + 1);

app/src/main/java/io/github/project516/NumberGuessingGame/ReadVersionFile.java

@@ -1,8 +1,17 @@
 package io.github.project516.NumberGuessingGame;
 
+/**
+ * Reads version information for the Number Guessing Game. Currently returns a placeholder version
+ * string.
+ */
 public class ReadVersionFile {
     // TODO - make this read the file in the resources directory
+    /**
+     * Retrieves the current version of the game. Currently returns "rolling" as a placeholder.
+     *
+     * @return the version string
+     */
     public String readVersion() {
-        return "0.0.5";
+        return "0.0.6";
     }
 }

app/src/main/java/io/github/project516/NumberGuessingGame/ScannerHelper.java

@@ -2,18 +2,37 @@
 
 import java.util.Scanner;
 
+/**
+ * Helper class for managing user input via Scanner. This class provides methods to read user
+ * guesses, usernames, and properly close the Scanner resource.
+ */
 public class ScannerHelper {
 
+    /** Scanner instance for reading user input from System.in. */
     public Scanner scan = new Scanner(System.in);
 
+    /**
+     * Reads the user's guess as an integer from standard input.
+     *
+     * @return the user's guess as an integer
+     */
     int userGuess() {
         return scan.nextInt();
     }
 
+    /**
+     * Reads the user's name as a string from standard input.
+     *
+     * @return the user's name as a string
+     */
     String userName() {
         return scan.nextLine();
     }
 
+    /**
+     * Closes the Scanner to release system resources. Should be called when the Scanner is no
+     * longer needed.
+     */
     void close() {
         scan.close();
     }