v4.0

Changes (v4.0):

• Added quiz_app.exe
• Integrated server into main GUI.
• multiple ways to execute the app.

Packaged jar version

🎮 FNaF-Themed JavaFX Quiz App

Welcome to the FNaF Quiz App, an interactive, animated quiz application inspired by Five Nights at Freddy's. Built with JavaFX, this project features a rich UI, music, GIFs, and a themed pause menu for a polished, spooky quiz experience!

---

🚀 Getting Started

Prerequisites

• Java 21 (or higher, e.g., OpenJDK 23)
• JavaFX 21 SDK (JARs placed in the lib/ directory)
• Visual Studio Code with Java Extension Pack

Project Structure

📁 quiz_app_package/
├── app/
│   ├── run_app.bat                  # Batch file to run the quiz app
│   └── target/
│       ├── quiz_app-1.0-SNAPSHOT.jar
│       ├── original-quiz_app-1.0-SNAPSHOT.jar
│       └── classes/
│           └── ...                  # Compiled classes and resources
├── server/
│   ├── run_server.bat               # Batch file to run the server
│   └── target/
│       ├── server_app-1.0-SNAPSHOT.jar
│       ├── original-server_app-1.0-SNAPSHOT.jar
│       └── classes/
│           └── ...                  # Compiled server classes
├── javafx-sdk-23.0.2/               # JavaFX SDK (Windows)
│   ├── lib/
│   ├── bin/
│   └── ...                          # SDK files and legal docs
├── README.txt                       # This file

---

🏃 How to Run

You can run the application in one way

Using the Provided Batch File (Windows)

1. Double-click run_app.bat in the project root, or
2. Open a terminal in the project root and run:

   run_app.bat
   

Note: The batch file assumes Java and JavaFX are properly set up and referenced.

---

💡 Features

• 🧠 10-question quiz with randomized selection
• ⏱️ Countdown timer with animated progress bar
• 🎶 Background music that loops during the quiz
• ⏸️ Pause menu (ESC or pause button)
• GIF background (pause.gif)
• Themed buttons: Resume, Restart, Quit
• ✅ Correct/incorrect answer highlighting
• 🎨 Themed UI with custom fonts and effects
• 📜 Responsive question layout

---

🌐 Online Mode

• Connects to a server on port 12345
• Sends a CONNECT command
• Submits score, time, and correct answers to the server
• Receives leaderboard rankings

---

✅ Requirements

1. Java 21+ (OpenJDK recommended)
2. JavaFX 21 SDK (JARs in lib/)
3. VSCode with Java Extension Pack

---

✍️ Customization

• Add questions to src/main/resources/txt/
• Replace background music in audio/
• Update GIFs/images in their respective folders

---

📬 Feedback

Have suggestions or want to fork this for another theme?
Send feedback or bug reports here.

---

⚖️ Legal

This project uses JavaFX, which is licensed under the GNU General Public License, version 2, with the Classpath Exception.
All Five Nights at Freddy's references and assets are for educational/fan use only. This project is not affiliated with or endorsed by Scott Cawthon or the official FNaF franchise.

---

Made with 💀, 🎃, and JavaFX and way too much coffee ☕.

Build System Upgrade with Persistent Leaderboard Support

🛠️ 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.

No build tool alpha

📦 Release: Initial Manual Build Version (v1.0)

This is the first release of the Quiz App with Leaderboard Server, created without any build tools. The application was manually compiled and run using javac and java. It includes a fully interactive JavaFX-based quiz client and a threaded leaderboard server.

---

🧩 Components

This project consists of two major components:

1. 🖥️ Quiz App (Client)
2. 🗄️ Leaderboard Server

---

🖥️ Quiz App (Client) Features

• 🧠 10-question quiz with randomized question selection on each run.
• ⏱️ Countdown timer with an animated progress bar that changes color (green → orange → red).
• 🎶 Looping background music during the quiz session.
• ⏸️ Pause menu accessible via the ESC key or a dedicated Pause button.
• 🖼️ Animated GIF background (pause.gif) shown during pause state.
• 🎨 Themed UI including:
  • Custom button styles: Resume, Restart, and Quit
  • Highlighting of ✅ correct and ❌ incorrect answers
  • Stylized fonts and drop shadows
• 📜 Responsive question layout with dynamic text wrapping and alignment.

---

🗄️ Leaderboard Server Features

• 📡 Accepts multiple client connections and processes quiz scores in real-time.
• 👥 Maintains a live leaderboard that ranks players based on score.
• 🔄 Thread-safe architecture using a thread pool to manage client communication.
• 💾 Persistent storage of scores in a file to retain leaderboard data between restarts.
• 🧪 Built-in command handling for CONNECT, START_QUIZ, and SUBMIT_SCORE.
• 🖥️ JavaFX GUI to:
  • Start/stop the server
  • Monitor logs and connected clients
  • Display current leaderboard entries

---

📁 Project Structure

src/
├── App.java             # Main entry point to launch the quiz client
├── Server.java          # Entry point for the server GUI (if used)
└── ...                  # Additional packages or resources

---

🛠️ How to Run (Manual Compilation)

Prerequisites

• Java 8 or higher
• JavaFX SDK 23.0.2 (included in javafx-sdk-23.0.2/)

How to run?

• Head to the App.java file in src/ , then click on run. (This requires Visual Studio Code or a similar IDE with Java set up.)

---

📂 File Locations

• Leaderboard Data:
  Stored in:

  ..\AssignmentGCIS124\txt\leaderboard.txt
  

• Audio & GIF Assets:
  Stored under a folder such as audio/, gifs/, or resources/.

---

⚠️ Known Limitations in v1.0

• ❌ No build tools (Maven/Gradle)
• ❌ No JAR packaging
• ❌ No batch scripts
• ❌ Manual compilation required
• ❌ Leaderboard file doesn't support packaging due to being package-dependent if it is to be packaged.

---

📄 License

JavaFX is distributed under the GPL v2 with the Classpath Exception.
See the javafx-sdk-23.0.2/legal/ folder for more details.

---

💬 Feedback & Issues

Found a bug or have a suggestion? Open an issue or contribute your improvements!