MAJOR: Game flow, Database(sqlite)

Release

Author: thembaxaba157

.github/workflows/main.yml

@@ -8,6 +8,7 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
@@ -24,10 +25,14 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: '20.8.1'
-  
+
       - name: Install Node.js dependencies
         run: |
-            npm install @semantic-release/git @semantic-release/git @semantic-release/exec
+            npm install @semantic-release/git @semantic-release/exec @semantic-release/github
+
+      - name: Build with Maven
+        run: mvn clean install
+
       - name: Run Semantic Release
         env:
           GITHUB_TOKEN: ${{ secrets.HANGMAN_TOKEN }}

.gitignore

@@ -4,6 +4,7 @@ target/classes
 target/classes/com/example/Main.class
 pom.xml.tag
 *classes
+code structure.txt
 pom.xml.releaseBackup
 pom.xml.versionsBackup
 pom.xml.next
@@ -44,4 +45,5 @@ buildNumber.properties
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 replay_pid*
-/target/classes/com/example/Main.class
+/target/classes/com/example/Main.class
+/hangman.db

.releaserc.yml

@@ -1,13 +1,28 @@
+# plugins:
+#   - "@semantic-release/commit-analyzer"
+#   - "@semantic-release/release-notes-generator"
+#   - - "@semantic-release/exec"
+#     - verifyReleaseCmd: 'mvn versions:set -DnewVersion="${nextRelease.version}" && echo "NEXT_VERSION=${nextRelease.version}" >> build.env'
+#   - "@semantic-release/github"
+#   - -  "@semantic-release/git"
+#     - assets:
+#         - pom.xml
+#       message: "chore(release): bump ${nextRelease.version}"
+
+# branches:
+#   - "main"
+#   - "+([0-9])?(.{+([0-9]),x}).x"
+
 plugins:
   - "@semantic-release/commit-analyzer"
   - "@semantic-release/release-notes-generator"
-  - - "@semantic-release/exec"
-    - verifyReleaseCmd: 'mvn versions:set -DnewVersion="${nextRelease.version}" && echo "NEXT_VERSION=${nextRelease.version}" >> build.env'
+  - "@semantic-release/exec"
+    verifyReleaseCmd: 'mvn versions:set -DnewVersion="${nextRelease.version}" && echo "NEXT_VERSION=${nextRelease.version}" >> build.env'
   - "@semantic-release/github"
-  - -  "@semantic-release/git"
-    - assets:
-        - pom.xml
-      message: "chore(release): bump ${nextRelease.version}"
+  - "@semantic-release/git"
+    assets:
+      - target/*.jar
+    message: "chore(release): bump ${nextRelease.version}"
 
 branches:
   - "main"

README.md

@@ -2,4 +2,96 @@ things used/will be used so far
 - sqlite
 - junit and mockito for testing
 - sementic versioning and workflows
-- json for words
+- json for words
+
+
+
+
+# Hangman Game - Rules & Mechanics
+
+## 📌 Overview
+The Hangman game is a word-guessing game where players try to complete a hidden word by guessing letters. Players can earn **points** for correct guesses and **scores** for winning rounds. Points can be used to **buy hints**, while scores determine leaderboard rankings.
+
+---
+
+## 🎯 Objectives
+- Correctly guess all the letters of a word before running out of attempts.
+- Earn **points** for each correct guess.
+- Earn **scores** by completing words.
+- Spend **points** to buy hints if stuck.
+- Maintain a **streak** for bonus rewards.
+
+---
+
+## 🏆 Score & 💰 Points System (Independent)
+| **Action**                         | **Effect on Points**            | **Effect on Score**             |
+|-------------------------------------|--------------------------------|---------------------------------|
+| Guess a correct letter             | +1 (Easy), +2 (Medium), +3 (Hard) | No effect                      |
+| Guess a wrong letter               | No effect                      | No effect                      |
+| Complete the word (Win)            | No effect                      | +Total Points Earned for the Round |
+| Lose the round                     | No effect                      | No effect                      |
+| Win multiple games in a row        | No effect                      | +Win Streak Bonus              |
+
+📌 **Points** = Earned per letter guessed correctly (used to buy hints).  
+📌 **Scores** = Only awarded when the player **wins a round** (used for leaderboard ranking).
+
+---
+
+## 🎮 Game Flow
+1️⃣ **Main Menu**: Play Game | Pick User | View Stats | Exit.  
+2️⃣ **Pick User** (Load | Delete | Create).  
+3️⃣ **Play** → Pick **Category** → Pick **Difficulty** → Start Game.  
+4️⃣ **Guess Letters**: Earn points per correct guess.  
+5️⃣ **Win or Lose**: Win to earn a score. Losing gives no points.  
+6️⃣ **Continue?**: Stay in the same difficulty to keep your current score.  
+7️⃣ **Use Points for Hints** (Optional).  
+
+---
+
+## 🛒 Hint System (Uses Points)
+| **Hint Type**                   | **Cost (Points)** |
+|---------------------------------|------------------|
+| **Reveal a random letter**      | 5 Points        |
+| **Shows the fact about the word** | 3 Points        |
+| **Remove a wrong letter choice**  | 4 Points        |
+
+📌 **Players can buy hints anytime using available points.**  
+📌 **Points do NOT reset between games (carry over).**
+
+---
+
+## 🔥 Streak & Challenge Bonuses
+- **Win Streak Bonus** → Consecutive wins increase the score multiplier.  
+- **Difficulty Progression Bonus** → Switching to a harder difficulty grants a +10% initial score boost.  
+- **"Almost Win" Compensation** → If a player is **90% close to winning**, they get 50% of their potential score.  
+
+---
+
+## 📜 Game Rules
+1️⃣ **If a player wins and continues without changing category/difficulty, the score carries over.**  
+2️⃣ **Players only earn a score if they win the round.**  
+3️⃣ **Points are earned per letter and used for hints.**  
+4️⃣ **Switching difficulty resets the score but keeps points.**  
+5️⃣ **Players lose after exceeding maximum incorrect guesses.**  
+6️⃣ **Leaderboard is based on score, not points.**  
+
+---
+
+## 🎯 Future Expansions
+- **Multiplayer Mode** with shared word pools.  
+- **Timed Challenges** (Earn more points for faster completion).  
+- **Daily Words & Streak Tracking**.  
+
+---
+
+## 🛠️ Developer Notes
+- **`GameSession`** → Runs gameplay loop, handles score & points.  
+- **`WordPicker`** → Selects a word based on category & difficulty.  
+- **`DisplayManager`** → Handles UI output (static methods).  
+- **`InputHandler`** → Manages user input.  
+- **`DatabaseManager` (Future)** → Stores leaderboard & user data (SQLite).  
+
+---
+
+This document serves as a **reference for coding**. You can update it as features evolve. 🚀
+

pom.xml

@@ -17,14 +17,23 @@
     <dependencies>
     <!-- sqlite: JDBC -->
 
-     <dependency>
-        <groupId>org.xerial</groupId>
-        <artifactId>sqlite-jdbc</artifactId>
-        <version>3.42.0.0</version>
-        <scope>test</scope>
-    </dependency>
+        <dependency>
+            <groupId>org.xerial</groupId>
+            <artifactId>sqlite-jdbc</artifactId>
+            <version>3.42.0.0</version>
+        </dependency>
 
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.16.1</version>
+        </dependency>
 
+        <dependency>
+            <groupId>com.googlecode.json-simple</groupId>
+            <artifactId>json-simple</artifactId>
+            <version>1.1.1</version>
+        </dependency>
 
     <!-- JUnit 5 -->
     <dependency>
@@ -47,6 +56,15 @@
         <version>5.6.0</version>
         <scope>test</scope>
     </dependency>
+
+    <dependency>
+		<groupId>org.projectlombok</groupId>
+		<artifactId>lombok</artifactId>
+		<version>1.18.36</version>
+		<scope>provided</scope>
+	</dependency>
+
+
 </dependencies>