Skip to content

Ankesh-erek/SilicoQuest

Repository files navigation

🌟 SilicoQuest : The Rock That Became a Brain

SilicoQuest Banner

An interactive, educational web application designed for students (Class 8-12) to explore semiconductor fabrication and computer science through captivating storytelling, dynamic animations, and fun mini-games. Now enhanced in v3.5 with comprehensive fixes, improved responsiveness, and robust functionality for a seamless learning experience!

🎯 Overview

SilicoQuest guides students on an epic journey from simple sand to sophisticated silicon chips, revealing how quartz transforms into the "brain" of modern computers. Across 8 immersive chapters, learners discover:

  • Silicon extraction and purification
  • Crystal growth techniques
  • Wafer fabrication processes
  • Logic gate assembly
  • Circuit design principles
  • Programming basics
  • The revolutionary impact of silicon technology

With v3.5, we've squashed bugs, boosted performance, and added fallbacks to ensure the app runs smoothly on any device.

🚀 Key Features

  • Engaging Storytelling: 8 chapters packed with animated visuals and voice narration
  • Silico Character: Adorable, evolving silicon atom guide with enhanced animations
  • Interactive Mini-Games: Chapter-specific challenges like sorting, precision control, and puzzles
  • Progress Tracking: Visual progress bar, auto-save via local storage, and completion markers
  • Mobile-First Design: Fully responsive for phones, tablets, and desktops
  • Certificate System: Generate and download personalized completion certificates (with fallback options)
  • Robust Error Handling: Fallback modes for missing components, ensuring uninterrupted learning
  • New in v3.5: Enhanced components, fixed navigation, improved games, and testing utilities

📁 Project Structure

SilicoQuest_v3.5/
├── .qodo/                          # Tool-specific directory (e.g., for development aids)
├── add_fixes.html                  # HTML for applying fixes to the app
├── app.js                          # Core application logic
├── app_enhanced.js                 # Enhanced version of app logic with fixes
├── assets/                         # Static assets
│   ├── audio/                      # Voice narration files (MP3)
│   └── images/                     # Visual assets (SVG, PNG, JPG)
├── components/                     # Modular JavaScript components
│   ├── Certificate.js              # Certificate generation system
│   ├── ChapterManager.js           # Chapter progression and data management
│   ├── GameLoader.js               # Mini-game loader and implementations
│   ├── GameLoader_Enhanced.js      # Enhanced game loader with fixes
│   ├── SilicoCharacter.js          # Character animation controller
│   └── SilicoCharacter_Enhanced.js # Enhanced character controller
├── data/                           # Application data
│   └── chapters.json               # Chapter content and narration data
├── fixes.js                        # Basic fix implementations
├── fixes_comprehensive.js          # Comprehensive fixes for all identified issues
├── FIXES_IMPLEMENTATION_GUIDE.md   # Guide for implementing and understanding fixes
├── fixes_summary.md                # Summary of fixes and improvements
├── index.html                      # Main application entry point
├── integrate_fixes.html            # HTML for integrating fixes
├── main.css                        # Main stylesheet with animations and responsive design
├── README.md                       # This documentation file
���── test_all_fixes.html             # Test page with all fixes applied
├── test_fixed_webpage.html         # Comprehensive test version of the fixed app
└── test_fixes.html                 # Additional test page for fixes

🎮 Chapter Breakdown

  1. The Sand of Intelligence - Identify and sort quartz in a fun collection game
  2. The Great Purification - Master furnace controls for silicon purification
  3. Growing the Perfect Crystal - Precision game for crystal formation
  4. Slicing the Silicon Wafer - Cut and polish wafers with accuracy
  5. Building Logic Gates - Puzzle-based gate design
  6. Connecting the Brain - Wire up circuits interactively
  7. Programming the Silicon Brain - Visual programming challenges
  8. The Silicon Revolution - Quiz and reflection on tech's impact

🛠️ Setup & Getting Started

Quick Launch

  1. Open index.html (or test_fixed_webpage.html for the enhanced v3.5 experience) in a modern browser.
  2. Click the welcome popup to dive in.
  3. Navigate through chapters with intuitive controls.

Development Setup

  1. Clone or download the repository.
  2. Use a local web server (e.g., via VS Code Live Server) for optimal audio playback.
  3. Place MP3 audio files in assets/audio/ (e.g., scene1_1.mp3).
  4. Edit chapter data in data/chapters.json.

For testing fixes: Use test_fixed_webpage.html to experience the fully patched app with fallbacks.

🎨 Customization Guide

  • New Chapters: Update data/chapters.json and extend games in GameLoader_Enhanced.js.
  • Game Tweaks: Modify logic in GameLoader.js or use the enhanced version for better stability.
  • Styling: Refine main.css with new animations, responsive breakpoints (480px, 768px).
  • Enhance Fixes: Build on fixes_comprehensive.js for custom improvements.

📱 Compatibility & Requirements

  • Browsers: Chrome 80+, Firefox 75+, Safari 13+, Edge 80+ (tested with v3.5 fixes)
  • Tech Stack: ES6 JavaScript, CSS Grid/Flexbox, Canvas API, Local Storage
  • Dependencies: jsPDF & html2canvas for certificates (loaded dynamically)
  • Optional: Web Audio API for narration, Web Share API for sharing

🎓 Learning Outcomes

  • Chemistry & Physics: Understand silicon processes and semiconductor science
  • Engineering: Explore manufacturing and quality control
  • Computer Science: Grasp logic, circuits, and coding fundamentals
  • Real-World Impact: Appreciate silicon's role in technology

Perfect for the CSIR Jigyasa Science Outreach Program!

🔧 What's New in v3.5

  • Comprehensive bug fixes (navigation, games, certificate modal)
  • Enhanced responsive design and mobile support
  • Fallback systems for robust performance
  • New testing files for easy validation
  • Optimized animations and error handling

See fixes_summary.md for detailed changes.

🚀 Deployment Tips

  • Local: Serve via HTTP for development.
  • Web: Host on HTTPS-enabled servers (required for audio in production).
  • Optimization: Enable caching for assets; test on multiple devices.

🤝 Contributing

Fork the repo, create feature branches, test thoroughly, and submit pull requests. Focus on educational enhancements!

📄 License

Open for educational use under the CSIR Jigyasa Program. Commercial use requires permission.

🆘 Troubleshooting

  • Audio Issues: Check MP3 format and HTTPS serving.
  • Navigation Stuck: Use skip features or check console for errors.
  • Certificate Fails: Try fallback text download; ensure libraries load.
  • Progress Lost: Verify Local Storage is enabled.

For support, review fixes_summary.md or browser console logs.


Crafted with passion for CSIR Jigyasa 🚀
Empowering young minds to unlock the secrets of silicon and beyond!

Made with Love Version 3.5

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors