Skip to content

Commit dffff8d

Browse files
Updated readme file according to the changes made.
1 parent ae98966 commit dffff8d

1 file changed

Lines changed: 33 additions & 25 deletions

File tree

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Missions are grouped into three categories on the Hub:
1212

1313
### 🎭 Social Engineering
1414
#### 1. 🕵️ Phishing Detective
15-
* **Adaptive Difficulty:** Timer adjusts based on your XP rank — 10s (Novice), 7s (Specialist), 5s (Elite Guardian). Difficulty badge shown in the AI label.
15+
* **Adaptive Difficulty:** Timer adjusts based on your XP rank — 30s (Novice), 27s (Specialist), 25s (Elite Guardian). Difficulty badge shown in the AI label.
1616
* **Timed Scenarios:** Countdown per question across 5 curated + 1 AI-generated scenario.
1717
* **Header Inspection:** Click the sender address to reveal raw `Authentication-Results` and `X-Original-Sender` headers.
1818
* **Hover-to-Reveal:** Preview destination URLs to spot domain spoofing (e.g., `amaz0n.in` vs `amazon.in`).
@@ -37,7 +37,7 @@ Missions are grouped into three categories on the Hub:
3737

3838
#### 4. 🧩 Malware Escape
3939
* **Incident Response:** Manage "System Health" during an active ransomware outbreak.
40-
* **Terminal Interface:** Type commands (`isolate-network`, `run-antivirus`, `restore-backup`, etc.) into a live console.
40+
* **Terminal Interface:** Type commands (`isolate-network`, `run-antivirus`, `restore-backup`, etc.) into a live console with a clearly separated Execute button.
4141
* **Command History:** Use ↑/↓ arrow keys to navigate previous commands; Tab for auto-complete.
4242
* **Glitch Effect:** The UI visually degrades when System Health drops below 40.
4343
* **Safety Protocols:** Actionable security tips shown at mission end.
@@ -55,7 +55,7 @@ Missions are grouped into three categories on the Hub:
5555
* **Completion Screen:** Deep Dive (Adobe 2013 breach, Collection #1 2019) and safety protocols shown at mission end.
5656
* **XP Lock:** Requires 50 XP to unlock.
5757

58-
#### 7. 🚨 Incident Response Simulator *(New)*
58+
#### 7. 🚨 Incident Response Simulator
5959
* **Branching Scenario Tree:** Navigate a realistic multi-step corporate breach — from a phishing email through credential theft, ransomware deployment, and regulatory reporting.
6060
* **Consequence Engine:** Every decision has an immediate consequence shown before the next scene loads. Wrong calls add to the Breach Damage meter.
6161
* **Breach Damage Meter:** A 0–100% damage bar tracks cumulative harm from poor decisions across the scenario.
@@ -65,18 +65,18 @@ Missions are grouped into three categories on the Hub:
6565
* **XP Lock:** Requires 100 XP to unlock.
6666

6767
### 🛠️ Tools & Knowledge
68-
#### 8. ⚡ Daily Challenge *(New)*
68+
#### 8. ⚡ Daily Challenge
6969
* **One Question Per Day:** A single scenario-based question drawn from a 12-question pool (Phishing, Social Engineering, Password, Malware, Smishing, MFA, Dark Web, Quishing) — seeded deterministically so every player gets the same question each day.
7070
* **30-Second Timer:** Faster correct answers earn more XP (up to 30 XP; wrong answers earn 5 XP).
7171
* **Daily Leaderboard:** Top-10 scores for the current day stored in Firestore under `dailyScores/{dateKey}/players`.
7272
* **Already-Played State:** Shows a live countdown to the next challenge if you've already completed today's question.
7373
* **Explanation Panel:** After answering, the correct answer and a detailed explanation are revealed.
7474

7575
#### 9. 📱 Smishing Simulator
76-
* **Mobile Interface:** Identify malicious SMS messages within a realistic phone frame.
77-
* **Drag-and-Drop:** Drag SMS bubbles into "Scam" or "Safe" bins, or use the on-screen buttons.
78-
* **Quishing (QR Phishing):** Some messages contain mock QR codes — tap to reveal the hidden malicious URL before deciding.
79-
* **Completion Screen:** Score summary, grade, Deep Dive (FluBot 2021, USPS scam wave) and safety protocols shown at mission end.
76+
* **Two-Column Layout:** Phone frame on the left, Scam/Safe drop bins and feedback on the right — everything visible without scrolling.
77+
* **Drag-and-Drop:** Drag SMS bubbles into "Scam" or "Safe" bins, or click the bins directly.
78+
* **Quishing (QR Phishing):** Some messages contain mock QR codes — click "🔍 Click to reveal hidden URL" to inspect the destination before deciding. Safe links show `https://`, scam links use `http://` or suspicious domains.
79+
* **Completion Screen:** Replaces the game layout entirely — shows score, grade, collapsible Deep Dive (FluBot 2021, USPS scam wave), and safety protocols. Title updates to "📱 Smishing Simulation Complete".
8080

8181
#### 10. 🧪 Mission Creator
8282
* **Custom Scenario Builder:** Fill in Sender, Subject, Body, and Link fields with a live email preview pane.
@@ -95,7 +95,7 @@ Missions are grouped into three categories on the Hub:
9595

9696
* **Frontend:** HTML5, CSS3 (Retro-Cyberpunk aesthetic with CRT effects, scanlines, and neon animations). Fully responsive with mobile media queries (`<600px`, `601–900px`).
9797
* **Database & Auth:** **Firebase** (Firestore for XP/Leaderboard/Daily Scores and Firebase Auth for Email/Password + Google Sign-In).
98-
* **Audio Engine:** **Web Audio API** for an immersive soundscape — procedurally generated success, error, and click sounds, plus a full ambient cyberpunk music engine with bass drone, mid pad, and rhythmic pulse.
98+
* **Audio Engine:** **Web Audio API** — procedurally generated success, error, and click sounds, plus two selectable ambient music tracks (Cyberpunk and Dark Ambient) with reverb, arpeggios, kick/hihat rhythm, and LFO modulation.
9999
* **Logic:** Modular ES6+ JavaScript.
100100
* **AI Integration:** OpenRouter API (Mistral-7B) for live phishing scenario generation with a local fallback engine.
101101
* **Adaptive Learning:** `adaptive.js` engine delivers difficulty scaling (timer, extra steps) and actionable safety protocols based on user XP rank.
@@ -108,27 +108,30 @@ Missions are grouped into three categories on the Hub:
108108
| :--- | :--- |
109109
| **XP & Leaderboard** | Earn XP for every successful mission and climb the global top-5 ranks (stored in Firestore). |
110110
| **Rank System** | Novice (0 XP) → Specialist (100 XP) → Elite Guardian (500 XP), with a progress bar. |
111-
| **Adaptive Difficulty** | Timer and scenario complexity scale with XP rank. Novice: 10s timer. Specialist: 7s + extra social engineering steps. Elite: 5s + extra steps. |
111+
| **Adaptive Difficulty** | Timer and scenario complexity scale with XP rank. Novice: 30s timer. Specialist: 27s + extra social engineering steps. Elite: 25s + extra steps. |
112112
| **Achievements / Badges** | Unlock badges: 🔰 Rookie (0 XP), 🔍 Detective (50 XP), 🛡️ Shield (200 XP), 👑 Elite (500 XP). |
113113
| **Mission Locks** | Dark Web (50 XP), AI Crime Lab (75 XP), Incident Response (100 XP), Mission Creator (150 XP). Locked missions show a 🔒 overlay with the required XP. |
114-
| **Unlock Toasts** | When you earn enough XP to unlock a mission or feature, an animated toast notification appears. |
114+
| **🔔 Notification Bell** | When you earn enough XP to unlock a mission or feature, a red badge appears on the 🔔 bell icon in the top bar. Click it to see all unlocks — no intrusive popups. Mark all as read to clear the badge. |
115115
| **Hard Mode** | Unlocked at 300 XP — all missions run at Elite difficulty. |
116-
| **Mission Completion Tracker** | Profile panel shows ✅/⬜ status for all 10 missions. |
116+
| **Mission Completion Tracker** | Profile page shows ✅/⬜ status for all 10 missions. |
117117
| **Unlocks Panel** | Progress bars in the profile show how close you are to each locked mission/feature. |
118118
| **Daily Challenge** | One question per day from a 12-scenario pool. Faster answers earn more XP. Daily leaderboard resets at midnight. |
119119
| **System Health** | Visual health bar during Malware Escape; triggers glitch effects at low health. |
120120
| **Trust Level** | Real-time gauge of psychological manipulation in Social Engineering. |
121121
| **Breach Damage Meter** | Tracks cumulative damage from poor decisions in Incident Response. |
122122
| **Safety Protocols** | Actionable, real-world security tips shown at mission end for all mission categories. |
123123
| **Deep Dives** | Real-world case studies shown on mission completion screens (Phishing, Social, AI, Malware, Password, Dark Web, Smishing). |
124-
| **Onboarding Tour** | 7-step guided tour on first login with spotlight overlay, progress dots, and skip/back/next controls. Replay anytime via the 🧭 Tour button. |
124+
| **Onboarding Tour** | 6-step guided tour on first login with spotlight overlay, progress dots, and skip/back/next controls. Replay anytime via the 🧭 Tour button. |
125125
| **How to Play Guide** | Modal shown on first login with mission overview, key features, and pro tips. Accessible anytime via the 🎮 Guide button. |
126+
| **👤 Profile Page** | Dedicated profile page (`profile.html`) with XP, rank, badges, mission tracker, unlocks progress, and global leaderboard — accessible via the 👤 Profile button in the top bar. |
126127
| **Share Score** | Share your rank, XP, and missions completed via the Web Share API or clipboard copy. |
127128
| **Activity Ticker** | Live scrolling feed on the Hub simulating global community activity. |
128129
| **High Contrast Mode** | Accessibility toggle persisted via `localStorage`. |
129-
| **Font Size Controls** | A/A/A buttons in the audio bar to switch between small, medium, and large text. Persisted via `localStorage`. |
130-
| **Audio Controls** | Persistent volume slider, mute button, and ambient music toggle (bottom-right corner, all pages). |
130+
| **⚙️ Settings Panel** | Gear icon (fixed, top-right) opens a panel with Font Size (Small/Medium/Large dropdown), Music Track selector, Volume slider, Mute button, and Music ON/OFF toggle. All settings persisted via `localStorage`. |
131+
| **Music Tracks** | Two selectable ambient tracks: ⚡ Cyberpunk (120 BPM minor pentatonic arpeggio + kick/hihat + reverb) and 🌑 Dark Ambient (slow evolving pads + sub-bass + occasional deep thuds). |
132+
| **Audio Controls** | Volume slider, mute button, music toggle, and track selector — all inside the ⚙️ Settings panel. |
131133
| **Breadcrumbs** | Auto-injected navigation trail on all mission pages. |
134+
| **Personalized Greeting** | Hub shows "Hi, [name]!" using `displayName` for Google users or the part before `@` for email/password users. |
132135
| **ARIA & Accessibility** | `aria-live`, `role="progressbar"`, `role="alert"`, `role="toolbar"`, `aria-label` attributes throughout. `focus-visible` styles and `prefers-reduced-motion` support in CSS. |
133136

134137
---
@@ -137,30 +140,31 @@ Missions are grouped into three categories on the Hub:
137140

138141
```text
139142
CyberArena/
140-
├── hub.html # Mission Hub, User Profile, Achievements & Global Leaderboard
143+
├── hub.html # Mission Hub — missions only, top bar with Profile & Bell
144+
├── profile.html # Dedicated Profile page — XP, rank, badges, missions, unlocks, leaderboard
141145
├── index.html # Firebase Auth Portal (Email/Password + Google)
142146
├── phishing.html # Phishing Detective Mission
143147
├── social.html # Social Engineering Simulator
144148
├── ai.html # AI Crime Lab (Deepfake Detection)
145149
├── malware.html # Malware Escape (Terminal Interface)
146150
├── password.html # Password Strength, Entropy & MFA Lab
147151
├── darkweb.html # Breach Search & Risk Assessment Simulator
148-
├── smishing.html # Mobile SMS & QR (Quishing) Simulator
152+
├── smishing.html # Mobile SMS & QR (Quishing) Simulator — two-column layout
149153
├── incident.html # Incident Response Simulator (branching scenario tree)
150154
├── daily.html # Daily Challenge (one question/day + daily leaderboard)
151155
├── creator.html # Custom Phishing Mission Builder
152156
├── wiki.html # Cyber-Wiki Knowledge Base
153157
├── css/
154-
│ └── style.css # Neon-Cyberpunk UI Framework + mobile media queries + tour styles
158+
│ └── style.css # Neon-Cyberpunk UI Framework + mobile media queries + tour styles + settings panel
155159
└── js/
156160
├── firebase.js # Firebase Config & Initialization
157-
├── auth.js # Authentication Logic — addEventListener-based (no inline onclick)
161+
├── auth.js # Authentication Logic — shows "Hi, name!" greeting on login
158162
├── xp.js # XP & Firestore Data Management (updateXP, getUserData)
159-
├── common.js # Shared Navigation, Breadcrumbs, High Contrast, Font Size & Audio System
163+
├── common.js # Shared Navigation, Breadcrumbs, High Contrast, ⚙️ Settings Panel & Audio Engine
160164
├── audio.js # Standalone Audio Module (ES6 export)
161-
├── adaptive.js # Adaptive Difficulty Engine — timerSeconds, extraSteps, safetyProtocols
162-
├── tour.js # 7-step Onboarding Tour — spotlight overlay, dots, localStorage persistence
163-
├── unlocks.js # Mission/Feature Lock System — XP thresholds, lock overlays, unlock toasts
165+
├── adaptive.js # Adaptive Difficulty Engine — timerSeconds (30/27/25), extraSteps, safetyProtocols
166+
├── tour.js # 6-step Onboarding Tour — spotlight overlay, dots, localStorage persistence
167+
├── unlocks.js # Mission/Feature Lock System — XP thresholds, lock overlays, 🔔 notification bell
164168
├── guard.js # Mission Guard — redirects or blocks page if XP threshold not met
165169
├── daily.js # Daily Challenge Engine — seeded pool, Firestore score submission, leaderboard
166170
├── phishing.js # Phishing Detective Logic + AI Scenario Engine
@@ -169,7 +173,7 @@ CyberArena/
169173
├── malware.js # Malware Escape Terminal Logic
170174
├── password.js # Password Analysis, MFA & Fatigue Simulation + completion screen
171175
├── darkweb.js # Breach Database Search, Risk Assessment + completion screen
172-
├── smishing.js # SMS/QR Phishing Simulator Logic + completion screen
176+
├── smishing.js # SMS/QR Phishing Simulator — two-column layout, completion screen
173177
└── creator.js # Custom Mission Builder, JSON Export & educational breakdown
174178
```
175179

@@ -186,7 +190,7 @@ CyberArena/
186190
3. **Run Locally**
187191
* Open `index.html` in any modern web browser. A local server (e.g., VS Code Live Server) is recommended for Firebase ES modules to load correctly.
188192
4. **Or visit the live hosted version directly at [https://cyberarena-77a96.web.app](https://cyberarena-77a96.web.app)**
189-
4. **(Optional) Enable Live AI Scenarios**
193+
5. **(Optional) Enable Live AI Scenarios**
190194
* Get a free API key from [OpenRouter](https://openrouter.ai).
191195
* Open the Phishing Detective mission in your browser, press **F12** to open DevTools, and click the **Console** tab.
192196
* Paste the following and press Enter — do **not** run this in a terminal:
@@ -207,8 +211,12 @@ CyberArena/
207211
| `muted` | Audio mute state |
208212
| `volume` | Master volume level (0–1) |
209213
| `musicOn` | Ambient music on/off state |
214+
| `musicTrack` | Selected music track (`cyberpunk` or `dark`) |
210215
| `fontSize` | Font size class (`font-sm`, `font-md`, `font-lg`) |
216+
| `settingsPanelOpen` | Whether the ⚙️ settings panel is open or closed |
211217
| `openrouter_api_key` | OpenRouter API key for live AI phishing scenarios |
218+
| `seenUnlocks` | Array of unlock IDs already processed — prevents duplicate bell notifications |
219+
| `unlockNotifications` | Array of unlock notification objects `{ id, label, description, read }` for the 🔔 bell |
212220
213221
---
214222

0 commit comments

Comments
 (0)