https://github.com/codenkoffee/qubit-quantum-computing-game
https://github.com/codenkoffee/qubit-quantum-computing-game
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codenkoffee/qubit-quantum-computing-game
- Owner: CodeNKoffee
- Created: 2024-10-12T19:17:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-07T14:18:59.000Z (about 1 year ago)
- Last Synced: 2025-01-07T14:43:19.215Z (about 1 year ago)
- Language: JavaScript
- Size: 5.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quantum Fly 🎮
A cutting-edge web-based quantum-themed game that combines modern web technologies with innovative control mechanisms. Players control a quantum bit (qubit) through sound or facial expressions, navigating through a mesmerizing quantum realm.
## 🌟 Features
- **Innovative Controls**:
- Quantum Pulse Mode: Control your qubit through sound/clapping
- Grin Gravity Mode (Coming Soon): Control using facial expressions
- **Cross-Platform Compatibility**:
- Desktop browsers
- Mobile devices (Portrait mode optimized)
- Tablets
- **Social Features**:
- Global leaderboard
- Country representation system
- User profiles
- **Premium Features** (Coming Soon):
- Character skins
- Quantum trails
- Special effects
- **Monetization**:
- Virtual currency (Quantum Coins)
- Premium packages
- In-game shop
## 🚀 Technologies Used
- React.js with Vite
- Redux for state management
- Firebase (Authentication, Firestore, Analytics)
- TailwindCSS for styling
- Web Audio API for sound detection
- Canvas API for game rendering
## 🛠️ Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/quantum-fly.git
cd quantum-fly
```
2. Install dependencies:
```bash
npm install
```
3. Create a `.env` file in the root directory with your Firebase configuration:
```env
VITE_FIREBASE_API_KEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
VITE_FIREBASE_APP_ID=your_app_id
VITE_FIREBASE_MEASUREMENT_ID=your_measurement_id
```
4. Start the development server:
```bash
npm run dev
```
## 📱 Mobile Support
The game is optimized for mobile devices in portrait mode, featuring:
- Responsive UI elements
- Touch-friendly controls
- Adaptive canvas sizing
- Performance optimizations
## 🎮 How to Play
1. **Start**: Click "Start Game" on the main screen
2. **Choose Mode**: Select "Quantum Pulse" mode
3. **Controls**:
- Clap or make noise to make the qubit fly upward
- Stay quiet to let it fall
4. **Objective**: Navigate through quantum barriers to achieve the highest score
5. **Scoring**: Each barrier passed adds to your quantum score
6. **Game Over**: Colliding with barriers or the ground ends the game
## 💎 Premium Features
The game includes a virtual shop with:
- Quantum Coins packages
- Character customization (Coming Soon)
- Special effects (Coming Soon)
- Particle trails (Coming Soon)
## 🔒 License
This software is protected under a Proprietary License. All rights reserved.
To obtain a license:
1. Visit https://choosealicense.com/no-permission/
2. Copy the license text
3. Create a file named `LICENSE` in your project root
4. Add the following header to the license:
```
Copyright (c) [Year] [Your Name/Company]
All Rights Reserved
[Rest of the license text from choosealicense.com/no-permission/]
```
This license:
- Reserves all rights
- Prohibits distribution
- Prohibits modification
- Prohibits commercial use without permission
- Requires attribution
## 🤝 Contributing
This is a proprietary project and is not open for public contributions. All rights reserved.
## 📞 Support
For support, please contact [your-email@domain.com]
## 🔄 Updates
The game is regularly updated with:
- New features
- Performance improvements
- Security patches
- Bug fixes
## ⚠️ Requirements
- Modern web browser with WebGL support
- Microphone access for sound controls
- Stable internet connection
- Recommended: Chrome/Firefox/Safari latest version
## 🏗️ Development
For development:
```bash
# Install dependencies
npm install
# Start development server
npm run dev
# Build for production
npm run build
# Preview production build
npm run preview
```
## 🔐 Security
- Firebase Authentication for user management
- Secure environment variables
- Data encryption in transit
- Regular security updates
## 📈 Analytics
The game uses Firebase Analytics to track:
- User engagement
- Game performance
- Feature usage
- Error reporting
---
© [Year] [Your Name/Company]. All Rights Reserved.