📑 Table of Contents

• 🧩 Requirements
• 🎉 CS102 G3T7 - The Parade
• 🎮 Get Started
• ✨ Features
• 🧑‍🤝‍🧑 Local Play
• 🤖 AI Opponents
• 🕹 Game Setup
• 🏆 Victory Conditions
• 🔄 Replayability
• 🎮 Sample Gameplay
• 📖 Documentation
• 👥 Contributors

---

🧩 Requirements

• Java 21 or later (Recommended: Java 21 LTS)
• Terminal or IDE Console that supports:
• ANSI escape codes for colourful output 🌈
• Optional: Emoji rendering for full game experience 🎉
• View our UML diagram and slides in the appendix folder
• View GitHub Repository from the link below
  https://github.com/heyitsjshere/CS102-Project

---

🎉 CS102 G3T7 - The Parade

Experience the thrill of the Parade Card Game in two exciting modes: Local Play, VS AI Compete with up to 6 players and prove to everyone that you are the Parade Master!

---

🧩 Requirements

• Java 21 or later (Recommended: Java 21 LTS)
• Terminal or IDE Console that supports:
• ANSI escape codes for colourful output 🌈
• Optional: Emoji rendering for full game experience 🎉

🎮 Get Started

🚩 Objective: Collect cards strategically — lowest score wins!

To start playing the game, simply enter the following commands in your terminal
For Windows users,
If you are using Powershell, use
scripts\compile.bat ; scripts\run.bat
Else if you are using cmd.exe, use
scripts\compile.bat && scripts\run.bat

For Mac/Linux Users,
chmod +x scripts/*.bat
Followed by,
scripts/compile.bat && scripts/run.bat

OR
chmod +x scripts/*.sh
Followed by,
scripts/compile.sh && scripts/run.sh

---

✨ Features

• 🎨 Colourful, emoji-enhanced terminal gameplay
• 🧑‍🤝‍🧑 Play with up to 6 players (Human or AI!)
• 🔄 Replayable rounds with win tracking
• 🖥️ Fully interactive console interface

---

🧑‍🤝‍🧑 Local Play

Play with friends:

• Enter the number of players (1-6).
• Assign unique names to each player.

🤖 AI Opponents

Spice up your game by adding AI players!

• Add up to 5 AI players to challenge yourself.

---

🕹 Game Setup

Each game setup follows the same steps:

• Enter number of players
  "Select the number of players (1–6):"
• Provide player names
  "Enter name for Human Player:"

---

🎨 Emojis in Game

On some systems, emojis may appear as ?.
Don't worry — it's purely cosmetic!

---

🏆 Victory Conditions

The player with the lowest score at the end of the game wins!

• Collect cards strategically.
• Outsmart your opponents (or AI).
• Replay rounds to track your victories and become the ultimate Parade Master!

---

🔄 Replayability

• 🎮 Choose to replay with the same players or start fresh.
• 🏅 Track your total wins across multiple games.
• 🌈 Customize your strategies every game!

---

🎮 Sample Gameplay

|| Bot 2's turn || Parade: [BLACK 9, PURPLE 4, RED 7, PURPLE 5, GRAY 2, GREEN 10, GREEN 1] <== Card inserted here
Cards left in deck: 27
Bot 2 is selecting their cards...
Selection complete.

Player has played: RED 5
Player should collect: [PURPLE 4]
Collection: PURPLE 4

|| Junsheng's turn ||
Parade: [GRAY 9, RED 7, PURPLE 5, GRAY 2, GREEN 10, GREEN 1, RED 5] <== Card inserted here
Cards left in deck: 26

Your current collection:
You have no cards in your collection yet.
PICK A CARD

Option 1: RED 8 Option 2: PURPLE 3 Option 3: PURPLE 0 Option 4: YELLOW 10 Option 5: GREEN 7 Selection: Option <choose a number between 1 to 5>

---

📖 Documentation

To view our documentation, For Windows/Linux users, scripts\javadoc.bat

For Mac Users, sh scripts/javadoc.bat OR scripts/javadoc.sh

Head to our docs folder, click on index.html

---

👥 Contributors

This project was developed by:

• Junsheng
• Minyi
• Cheryl
• Liam
• Clemira
• Daniella

---

Enjoy the game and may the best player win! 🎉