Skip to content

Build System Upgrade with Persistent Leaderboard Support

Choose a tag to compare

View all tags
@Goldspear21 Goldspear21 released this 24 May 16:43
· 13 commits to main since this release
v2.0
ed04093

🛠️ Release: Maven Build, Batch Scripts & Improved Leaderboard Storage

This release introduces full Maven support, Windows batch files for easier launching, and a redesigned leaderboard storage system that now saves to a user directory on the host machine, improving persistence and portability.

✨ What's New

🧩 General

  • ✅ Maven-based build system (pom.xml included)
  • 📦 Clean build artifacts inside target/ folder
  • 💻 Batch files (run_app.bat, run_server.bat) for quick execution with proper JavaFX paths
  • 📁 Leaderboard file (leaderboard.txt) now saved under user-specific directory, e.g.:
    • C:\Users\<username>\QuizAppData\leaderboard.txt on Windows

🎮 Quiz App Features

  • 🧠 10-question quiz with randomized selection
  • ⏱️ Countdown timer with animated progress bar and color transitions (green → orange → red)
  • 🎶 Background music that loops during the quiz
  • ⏸️ Pause menu (press ESC or pause button)
  • 🎞️ GIF background (pause.gif)
  • 🎨 Themed buttons: Resume, Restart, Quit
  • ✅ Answer feedback with correct/incorrect highlighting
  • 📜 Responsive layout for different screen sizes
  • 🎭 Custom fonts and JavaFX styling for immersive UI

🖥️ Server Features

  • 🔌 Leaderboard server that listens for client connections on port 12345
  • 📥 Accepts and processes score submissions from quiz clients
  • 📊 Sends top 3 leaderboard entries back to clients
  • 👥 Displays connected clients in real-time
  • 🧵 Handles multiple clients concurrently using threads
  • 💾 Saves leaderboard to user-specific directory for persistence
  • 🪟 JavaFX GUI to start/stop the server, view logs, and track activity

📁 Project Structures

📂 quiz_app/ Project Structure

quiz_app/
├── .vscode/                         # VSCode config files
├── lib/                             # JavaFX JAR libraries
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── bhargav/
│   │   │       ├── App.java         # Entry point
│   │   │       ├── client/          # Client networking code
│   │   │       └── quiz/            # Quiz logic and GUI
│   │   └── resources/
│   │       ├── audio/               # Background music
│   │       ├── gifs/                # GIF backgrounds
│   │       ├── images/              # UI images
│   │       ├── txt/                 # Question banks and fallback leaderboard
│   │       └── videos/              # Optional media
│   └── test/
│       └── java/
│           └── bhargav/
│               └── TestQuiz.java    # JUnit tests
├── target/                          # Compiled output (via Maven)
│   └── quiz_app-1.0-SNAPSHOT.jar
├── run_app.bat                      # Batch script to run the quiz app
├── pom.xml                          # Maven build file
├── UML.png                          # UML class diagram
└── README.txt                       # Project documentation

📂 server_app/ Project Structure

server_app/
├── src/
│   └── main/
│       ├── java/
│       │   └── bhargav/
│       │       ├── Server.java                  # Entry point to launch server GUI
│       │       └── server/
│       │           ├── LeaderboardServer.java   # Handles server logic, client threads
│       │           └── LeaderboardServerGUI.java# GUI for controlling server
│       └── resources/                           # (Optional) Resource folder if needed
├── target/
│   └── server_app-1.0-SNAPSHOT.jar              # Compiled server JAR
├── run_server.bat                               # Batch script to launch server with JavaFX
├── javafx-sdk-23.0.2/                            # JavaFX SDK required for runtime
└── README.txt                                   # Project documentation

📦 How to Build

You can build both projects using Maven:

mvn clean package

The compiled .jar files will appear in the target/ directory of each project.

🚀 How to Run

🔹 Run Quiz App

run_app.bat

🔹 Run Leaderboard Server

run_server.bat

Ensure your environment has the JavaFX SDK properly set up, or the batch files include the correct module paths.

📂 Leaderboard Data Storage

Leaderboard files are now stored in a directory like:

Windows: C:\Users\<username>\QuizAppData\leaderboard.txt
macOS/Linux: /home/<user>/QuizAppData/leaderboard.txt

This avoids overwriting files in resources/ and ensures persistence.

📜 License

This project uses JavaFX and other dependencies under their respective licenses. See the javafx-sdk-23.0.2/legal/ folder for details.

🙋 Support

Open an issue on this repository for bugs, suggestions, or questions.

Assets 2
Loading