# GlitchRealm
### A Cyberpunk Browser Gaming Platform
[](https://glitchrealm.ca)
[](LICENSE)
[](LICENSE-ASSETS)
[](https://firebase.google.com/)
[](https://glitchrealm.ca)
**Discover, play, and track HTML5 games — all in one place.**
**PLEASE NOT ALL SIGN IN BUTTONS DO NOT WORK DUE TO ISSUES MOST HAVE BEEN REMOVED**
[Explore Games](https://glitchrealm.ca/games.html) · [Submit Your Game](https://glitchrealm.ca/submit-game.html) · [Join the Community](https://glitchrealm.ca/community.html) · [Report a Bug](https://github.com/InfinityByteStudios/GlitchRealm/issues)
---
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Architecture](#architecture)
- [Getting Started](#getting-started)
- [Project Structure](#project-structure)
- [Game Integration](#game-integration)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
---
## Overview
GlitchRealm is a browser-based gaming platform with a distinctive cyberpunk aesthetic. It provides a unified hub for discovering and playing HTML5 games with built-in user accounts, playtime tracking, community features, and a developer submission pipeline.
**Why GlitchRealm exists:** Browser gaming is fragmented. Players find games scattered across dozens of sites with no unified identity, no progress tracking, and no community. GlitchRealm brings everything together — a single platform where players track their gaming journey and developers reach an engaged audience.
### Design Principles
| Principle | Approach |
|-----------|----------|
| **Zero build complexity** | Pure HTML, CSS, and ES6+ JavaScript — no bundlers, no transpilers |
| **Serverless-first** | Firebase Authentication, Cloud Firestore, and Netlify edge delivery |
| **Progressive enhancement** | Core content works without JS; interactivity layers on top |
| **Security by default** | Comprehensive Firestore rules with multi-tier validation |
---
## Features
### Players
- **Curated Game Library** — browse and play HTML5 games directly in the browser
- **Unified Accounts** — sign up with email, Google, or GitHub
- **Playtime Tracking** — automatic session tracking across every game
- **Custom Avatars** — profile images powered by Supabase Storage
- **Reviews & Ratings** — rate games and read community feedback
- **Community Hub** — discussions, news articles, and platform updates
- **PWA Support** — install GlitchRealm as a desktop or mobile app
### Developers
- **Game Submission Portal** — guided multi-step form for submitting HTML5 games
- **Developer Dashboard** — analytics for plays, reviews, and engagement
- **Verification Badges** — earn a verified creator badge
- **Playtime SDK** — lightweight tracker to integrate into external games
- **Moderation Tools** — manage submissions and community content
### Platform
- **Responsive Design** — optimized for desktop, tablet, and mobile
- **Accessibility** — keyboard navigation and screen reader support
- **Performance** — lazy loading, CDN delivery, and aggressive caching
- **Offline Support** — service worker for offline fallback pages
---
## Architecture
### Tech Stack
| Layer | Technology |
|-------|------------|
| **Frontend** | HTML5, CSS3, ES6+ JavaScript (no framework) |
| **Auth** | Firebase Authentication v10.7.1 |
| **Database** | Cloud Firestore |
| **File Storage** | Supabase Storage |
| **Hosting** | Netlify (CDN + Edge Functions) |
| **Backend** | Firebase Cloud Functions (Node.js 20) |
### Key Patterns
**Global Firebase Services** — All Firebase SDK modules are initialized in `firebase-core.js` and exposed on the `window` object (`window.firebaseAuth`, `window.firebaseFirestore`, etc.) for cross-page access without a bundler.
**Zero Build Pipeline** — ES6 modules are imported directly from the Firebase CDN via `
```
**Hosting options:**
- **External** — host your game anywhere and link it via the submission form
- **On-platform** — place your game in a `/Games/YourGame/` folder with an `index.html` entry point
---
## Deployment
GlitchRealm is deployed on **Netlify** with automatic deploys from the `main` branch.
```bash
# Manual deploy
netlify deploy --prod
# Deploy Firestore rules
firebase deploy --only firestore:rules
# Deploy Cloud Functions
firebase deploy --only functions
```
### Required Environment Variables (Netlify Dashboard)
| Variable | Purpose |
|----------|---------|
| `FIREBASE_API_KEY` | Firebase project API key |
| `FIREBASE_AUTH_DOMAIN` | Firebase Auth domain |
| `SUPABASE_URL` | Supabase project URL |
| `SUPABASE_ANON_KEY` | Supabase anonymous key |
---
## Contributing
Contributions are welcome. Please read the [Code of Conduct](docs/CODE_OF_CONDUCT.md) before participating.
1. **Fork** the repository
2. **Create a branch:** `git checkout -b feature/your-feature`
3. **Commit your changes:** `git commit -m 'Add your feature'`
4. **Push:** `git push origin feature/your-feature`
5. **Open a Pull Request**
### Guidelines
- Keep the zero-build philosophy — no bundlers or transpilers
- Use the global Firebase pattern (`window.firebaseAuth`, etc.)
- Always include required Firestore fields when updating documents
- Test across Chrome, Firefox, Safari, and Edge
- Follow existing CSS variables and class naming conventions
---
## License
This project uses a **dual license**:
| Scope | License | Details |
|-------|---------|---------|
| Source code | [MIT](LICENSE) | Free to use, modify, and distribute |
| Non-code assets | [All Rights Reserved](LICENSE-ASSETS) | Logos, images, brand elements, game art |
"GlitchRealm" and "GlitchRealm Games" are trademarks of GlitchRealm Games. See [NOTICE](NOTICE) for details.
---
## Contact
| | |
|---|---|
| **Website** | [glitchrealm.ca](https://glitchrealm.ca) |
| **General Inquiries** | [contact@glitchrealm.ca](mailto:contact@glitchrealm.ca) |
| **Developer Support** | [developers@glitchrealm.ca](mailto:developers@glitchrealm.ca) |
| **Security Reports** | [security@glitchrealm.ca](mailto:security@glitchrealm.ca) |
| **Legal** | [legal@glitchrealm.ca](mailto:legal@glitchrealm.ca) |
| **Bug Reports** | [GitHub Issues](https://github.com/InfinityByteStudios/GlitchRealm/issues) |
---
**Built by the GlitchRealm team** · [glitchrealm.ca](https://glitchrealm.ca)