Skip to content

SatyaPujith/Dead-Scroll

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

7 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿชฆ Dead Scroll - Horror Website Blocker

Version License Chrome TypeScript

Break digital addictions through horror-themed website blocking and AI-powered educational quests.

Features โ€ข Installation โ€ข Usage โ€ข Documentation โ€ข Tech Stack


๐ŸŽฏ Overview

Dead Scroll is a Chrome extension that helps you break free from digital distractions by burying websites in a virtual graveyard. Want to access them? You'll need to complete an AI-powered educational quest first. Learn something new to earn your freedom!

๐ŸŒŸ Key Highlights

  • ๐Ÿ”’ Permanent Blocking - Sites stay buried until you complete the quest
  • ๐Ÿง  AI-Powered Learning - Educational content generated by Google Gemini
  • ๐Ÿ‘ป Horror Theme - Immersive dark aesthetic with animations
  • ๐ŸŽฎ Quiz Combat - Battle ghosts by answering questions correctly
  • ๐Ÿ“Š Progress Tracking - Monitor your attempts and learning journey

โœจ Features

๐Ÿชฆ Website Burial System

  • Block any website for 1-365 days
  • Sites remain in the graveyard even after the burial period
  • Must manually delete to permanently unblock
  • Prevents duplicate entries

๐Ÿง™โ€โ™‚๏ธ Educational Quest System

  • Topic Selection - Choose any subject you want to learn
  • AI Content Generation - Gemini creates 5 educational sections with quizzes
  • Halloween Sound Effects - Spooky audio feedback for correct/wrong answers
  • Combat Mechanics - Correct answers kill ghosts, wrong answers cost hearts
  • Progressive Learning - Complete all sections to unlock the site

๐ŸŽจ Horror Aesthetic

  • Dark, immersive UI with Creepster font
  • Animated effects and transitions
  • Blood-red accents and skull icons
  • Consistent theme across all screens

๐Ÿ“ˆ Smart Features

  • Attempt tracking for each blocked site
  • Auto-deletion after quest completion
  • Duplicate blocking prevention
  • Chrome tab integration

๐Ÿš€ Installation

Prerequisites

  • Node.js 20+ and npm
  • Chrome 120+ or any Chromium-based browser
  • Google Gemini API key (free)

Quick Start

# 1. Clone the repository
git clone https://github.com/yourusername/deadscroll.git
cd deadscroll

# 2. Install dependencies
npm install

# 3. Set up your API key
cp .env.example .env.local
# Edit .env.local and add your Gemini API key

# 4. Build the extension
npm run build

# 5. Load in Chrome
# - Open chrome://extensions/
# - Enable "Developer mode"
# - Click "Load unpacked"
# - Select the "dist" folder

๐Ÿ”‘ API Key Setup

Get your free Gemini API key:

  1. Visit Google AI Studio
  2. Sign in and click "Create API Key"
  3. Copy your key

Add to the extension:

Option 1: Environment Variable (Recommended)

# Edit .env.local
VITE_GEMINI_API_KEY=your_actual_api_key_here

# Rebuild
npm run build

Option 2: Browser Console

// Open extension popup, press F12, run:
localStorage.setItem('gemini_api_key', 'YOUR_API_KEY_HERE');

โš ๏ธ Security Note: Never commit your .env.local file. It's already in .gitignore.


๐Ÿ“– Usage

1๏ธโƒฃ Bury a Website

Open Extension โ†’ Enter URL โ†’ Set Duration โ†’ Click "BURY FOREVER"
  • Enter domain (e.g., instagram.com, youtube.com)
  • Choose burial duration (1-365 days)
  • Site is added to your graveyard

2๏ธโƒฃ Try to Visit Blocked Site

When you attempt to visit a buried site:

  • Horror block screen appears
  • Click "LEARN TO ESCAPE"
  • Choose a topic to learn about

3๏ธโƒฃ Complete the Quest

Learning Flow:

Topic Input โ†’ AI Generation โ†’ Read Section โ†’ Quiz โ†’ Combat
  • Read educational content
  • Answer quiz questions
  • Correct โœ… = Kill ghost, next section
  • Wrong โŒ = Lose heart, try again
  • Complete all 3 sections = Victory!

4๏ธโƒฃ Unlock & Learn

  • Site opens in new tab
  • Automatically removed from graveyard
  • You've learned something new! ๐ŸŽ“

๐ŸŽฎ How It Works

Combat System

Action Result
โœ… Correct Answer Kill ghost โ†’ Next section
โŒ Wrong Answer Lose 1 heart โ†’ Retry quiz
๐Ÿ’€ Lose All Hearts Restart from beginning
๐Ÿ† Complete All Sections Site unlocked!

Health System

  • Start with 3 hearts โค๏ธโค๏ธโค๏ธ
  • Wrong answer = -1 heart
  • No hearts = Quest restarts

๐Ÿ› ๏ธ Tech Stack

Frontend

  • React 18 - UI framework
  • TypeScript - Type safety
  • Framer Motion - Smooth animations
  • Tailwind CSS - Styling

Build & Tools

  • Vite - Fast build tool
  • Chrome Extension Manifest V3 - Latest extension API
  • Google Gemini API - AI content generation

Architecture

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚   Extension     โ”‚
โ”‚   Popup (React) โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
         โ”‚
    โ”Œโ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”
    โ”‚         โ”‚
โ”Œโ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ” โ”Œโ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ Horrorโ”‚ โ”‚Learning โ”‚
โ”‚ Block โ”‚ โ”‚ Quest   โ”‚
โ””โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”˜
    โ”‚        โ”‚
    โ””โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”˜
         โ”‚
    โ”Œโ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
    โ”‚  Background โ”‚
    โ”‚   Service   โ”‚
    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

๐Ÿ“š Documentation

Comprehensive documentation is available in the docs/ folder:

๐Ÿ“˜ User Guides

๐Ÿ” Security & Setup

๐Ÿ”ง Technical Docs

๐Ÿ“ Change Logs

๐Ÿ“– See docs/README.md for complete documentation index


๐ŸŽจ Screenshots

Main Dashboard

Dark horror-themed interface with graveyard management

Horror Block Screen

Immersive blocking experience with dramatic effects

Learning Quest

AI-generated educational content with quiz combat

Victory Screen

Celebrate your learning achievement


๐Ÿ“ Development

Commands

# Install dependencies
npm install

# Development mode (watch)
npm run dev

# Build for production
npm run build

# Type checking
npm run type-check

Project Structure

skinnerbox/
โ”œโ”€โ”€ components/          # React components
โ”‚   โ”œโ”€โ”€ LearningQuest.tsx
โ”‚   โ”œโ”€โ”€ HorrorBlock.tsx
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ services/           # Service layer
โ”‚   โ””โ”€โ”€ storageService.ts
โ”œโ”€โ”€ docs/              # Documentation
โ”œโ”€โ”€ dist/              # Build output
โ”œโ”€โ”€ App.tsx            # Main app component
โ”œโ”€โ”€ background.js      # Extension background script
โ””โ”€โ”€ manifest.json      # Extension manifest

๐Ÿ› Known Issues

  • Font loading warnings (cosmetic only, doesn't affect functionality)
  • Chrome 120+ required for full feature support

See TROUBLESHOOTING.md for solutions.


๐Ÿ”ฎ Future Enhancements

  • Multiple AI provider support (OpenAI, Claude)
  • Configurable quest difficulty
  • Statistics dashboard
  • Achievement system
  • Multi-language support
  • Content caching to reduce API calls
  • Custom quiz topics per website

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


๐Ÿ™ Acknowledgments

  • Google Gemini - AI content generation
  • Framer Motion - Smooth animations
  • Lucide Icons - Beautiful icon set
  • Creepster Font - Horror typography

Made with ๐Ÿ–ค and โ˜ ๏ธ

Break free from digital distractions, one quest at a time.

โฌ† Back to Top

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published