Skip to content

ProfessorMoose74/eggshell

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

50 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

EGGSHELL Desktop Environment v2.0 ๐Ÿฅšโœจ

Vision: "Where Young Minds Hatch New Ideas"

EGGSHELL is a revolutionary Android-inspired desktop environment specifically designed for educational use, featuring comprehensive VR/AR integration, advanced accessibility, and voice control. Perfect for the mobile-native generation!


๐ŸŒŸ What Makes EGGSHELL Special

๐Ÿ“ฑ Android-Inspired Interface

  • Mobile-First Design: Familiar Android-like interface that kids intuitively understand
  • Touch-Friendly: Large buttons, swipe gestures, and card-based layouts
  • Material Design 3: Modern, beautiful UI with smooth animations and effects
  • Bottom Navigation: Android-style home/back/recent app navigation

๐Ÿฅฝ Universal VR/AR Integration

  • Helyxium Platform: Universal VR support for all major headsets
  • Comprehensive Hardware Support: Meta Quest (1,2,3,Pro,3S), PlayStation VR, Valve Index, HTC Vive, Windows Mixed Reality, Apple Vision Pro, Pico devices
  • Educational VR Sessions: Mathematics, science, language learning, historical exploration
  • Real-Time Detection: Automatic VR device recognition and capability assessment

๐ŸŽค Advanced Voice Control

  • System-Wide Voice Commands: Navigate desktop, launch apps, control settings
  • Speech Recognition: Natural language processing for educational interactions
  • Visual Feedback: Animated microphone with pulse and ripple effects
  • Multi-Language Support: English, Spanish, French, German, Chinese, Japanese

โ™ฟ Comprehensive Accessibility

  • Visual Sound Indicators: Convert audio to visual cues for hearing impaired
  • Closed Captions: System-wide captioning with customizable positioning
  • High Contrast Themes: Enhanced visibility options
  • Screen Reader Ready: Full compatibility with accessibility tools

๐ŸŽจ Dynamic Visual Experience

  • Animated Wallpapers: Aurora Borealis, floating particles, wave motion, geometric flow
  • VR-Themed Backgrounds: Special wallpapers for VR environments
  • Modern UI Effects: Glassmorphism, neumorphism, ripple effects, loading animations
  • Time-Based Brightness: Automatic adjustment for day/evening/night

๐Ÿ“š Educational Focus

  • Elemental Genius Integration: Seamless connection to educational platform
  • Age-Appropriate Interfaces: Adaptive UI for different age groups (6-18)
  • Learning Analytics: Progress tracking and educational insights
  • Classroom Management: Multi-user support and teacher dashboard

๐Ÿš€ Quick Installation

One-Line Universal Installer โšก

curl -fsSL https://raw.githubusercontent.com/eggshell-project/eggshell/main/install-eggshell.sh | bash

Distribution-Specific Packages ๐Ÿ“ฆ

Ubuntu/Debian:

wget https://github.com/eggshell-project/eggshell/releases/latest/download/eggshell_2.0.0-1_amd64.deb
sudo dpkg -i eggshell_2.0.0-1_amd64.deb
sudo apt-get install -f

OpenSUSE/RHEL:

wget https://github.com/eggshell-project/eggshell/releases/latest/download/eggshell-2.0.0-1.x86_64.rpm
sudo rpm -i eggshell-2.0.0-1.x86_64.rpm

Universal Linux (AppImage):

wget https://github.com/eggshell-project/eggshell/releases/latest/download/EGGSHELL-2.0.0-x86_64.AppImage
chmod +x EGGSHELL-2.0.0-x86_64.AppImage
./EGGSHELL-2.0.0-x86_64.AppImage

๐Ÿ–ฅ๏ธ System Requirements

Minimum Requirements

  • OS: Ubuntu 22.04+, OpenSUSE Leap 15.6+, or equivalent
  • CPU: x86_64 dual-core processor (ARM64 also supported)
  • RAM: 4GB (8GB recommended)
  • Storage: 2GB free space
  • Graphics: OpenGL 3.3+ support

VR-Ready Configuration ๐Ÿฅฝ

  • RAM: 16GB+ recommended
  • Graphics: Dedicated GPU with VR support
  • USB: USB 3.0+ ports for VR headsets
  • Storage: Additional 5GB for VR content and applications

Supported Distributions

  • Ubuntu: 22.04 LTS, 24.04 LTS
  • OpenSUSE: Leap 15.6+, Tumbleweed
  • Debian: 12+ (Bookworm)
  • Fedora: 38+
  • Arch Linux: Latest
  • RHEL/CentOS: 9+

๐ŸŽฏ Key Features

๐Ÿ  Android-Style Home Screen

  • App Grid Layout: 4x5 grid with smooth page swiping
  • Search Functionality: Real-time app filtering
  • Voice Integration: Launch apps with voice commands
  • Quick Settings Panel: Swipe-down controls for VR, wallpapers, accessibility

๐Ÿฅฝ VR/AR Capabilities

  • Educational VR Sessions:

    • ๐Ÿงฎ Mathematics VR: Interactive 3D geometry and algebra
    • ๐Ÿ”ฌ Science Lab VR: Virtual chemistry and physics experiments
    • ๐Ÿ—ฃ๏ธ Language World VR: Immersive language learning environments
    • ๐Ÿ›๏ธ Historical Timeline VR: Walk through historical events
    • ๐ŸŽจ 3D Art Studio VR: Create and sculpt in virtual space
  • Hardware Support:

    • Meta Quest family (1, 2, 3, Pro, 3S)
    • PlayStation VR (PSVR, PSVR2)
    • Valve Index with full tracking
    • HTC Vive series (original, Pro, Pro 2, Cosmos)
    • Windows Mixed Reality headsets
    • Apple Vision Pro
    • Pico 4 and other standalone devices

๐ŸŽค Voice Control System

  • Natural Commands: "Open apps", "Go home", "Show settings", "Launch VR"
  • Visual Feedback: Animated microphone with status indicators
  • Error Handling: User-friendly error messages and retry options
  • Integration: Works with all desktop functions and VR sessions

โ™ฟ Accessibility Excellence

  • Visual Sound System:
    • Position-based indicators (speech=top, notifications=top-right)
    • Animation types: pulse, wave, glow, bounce, flash
    • Customizable colors and intensity levels
  • Closed Captions: Real-time captions with speaker identification
  • Voice Navigation: Complete desktop control via voice commands
  • High Contrast: Enhanced visibility themes and options

๐ŸŽจ Modern Visual Design

  • Dynamic Wallpapers:

    • Aurora Borealis: Animated color-changing gradients
    • Floating Particles: Interactive particle systems
    • Wave Motion: Fluid wave animations with physics
    • Geometric Flow: Abstract geometric patterns
    • VR Space: 3D grid environments for VR mode
    • AR Grid: Augmented reality scan line effects
  • UI Effects Library:

    • Glassmorphism: Frosted glass panels and overlays
    • Neumorphism: Soft 3D button effects
    • Ripple Effects: Material Design touch feedback
    • Loading Animations: Modern progress indicators
    • Toast Notifications: Elegant popup messages

๐Ÿ—๏ธ Architecture & Components

Frontend (Qt6/QML)

  • main.qml - Main application window and coordination
  • AndroidHomeScreen.qml - Mobile-inspired launcher interface
  • VoiceControl.qml - Voice recognition and feedback system
  • WallpaperManager.qml - Dynamic background system
  • AccessibilityVisualIndicator.qml - Sound visualization for hearing impaired
  • HelyxiumIntegration.qml - VR platform bridge
  • ModernUIEffects.qml - Advanced visual effects library
  • AndroidMaterialTheme.qml - Material Design 3 color system

Backend Integrations

  • Helyxium VR Platform: Universal VR hardware detection and management
  • Elemental Genius API: Educational content and progress tracking
  • Qt Speech: Voice recognition and text-to-speech
  • Qt Multimedia: Audio/video processing for accessibility
  • WebSockets: Real-time communication with VR systems

Build System

  • CMake: Cross-platform build configuration
  • CPack: Multi-format package generation (DEB, RPM, AppImage)
  • Qt Resource System: Embedded QML and assets
  • Platform Detection: Automatic OS and hardware detection

๐Ÿ”ง Development & Building

Build from Source

git clone https://github.com/eggshell-project/eggshell.git
cd eggshell
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc)
sudo make install

Package Building

# Build all package types
./build-packages.sh

# Available packages:
# - DEB for Ubuntu/Debian
# - RPM for OpenSUSE/RHEL/Fedora  
# - AppImage for universal Linux
# - Source tarball for custom builds

Development Tools

# Run in development mode
make run

# Clean build environment
make clean-all

# Run with debug output
QT_LOGGING_RULES="*.debug=true" ./eggshell

๐Ÿ“– Documentation & Support

User Guides

Educational Resources

Developer Documentation

Community & Support


๐Ÿค Contributing

EGGSHELL is open source and welcomes contributions!

Ways to Contribute

  • ๐Ÿ’ป Code: Bug fixes, new features, performance improvements
  • ๐ŸŒ Translations: Help make EGGSHELL accessible worldwide
  • ๐Ÿ“– Documentation: Improve guides, tutorials, and API docs
  • ๐ŸŽจ Design: UI/UX improvements, icons, themes
  • ๐Ÿงช Testing: Bug reports, compatibility testing, VR hardware testing

Development Setup

# Clone repository
git clone https://github.com/eggshell-project/eggshell.git
cd eggshell

# Install development dependencies
sudo apt install qt6-dev cmake g++ python3-dev

# Build and run
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug
make && ./eggshell

Coding Standards

  • C++20 with Qt6 best practices
  • QML Material Design guidelines
  • Comprehensive accessibility testing
  • Multi-language support considerations

๐Ÿ“Š Project Stats

  • ๐ŸŒŸ Languages: C++, QML, Python, JavaScript
  • ๐Ÿ—๏ธ Framework: Qt6 with Material Design
  • ๐ŸŽฏ Target Age: 6-18 years (educational focus)
  • ๐ŸŒ Supported Languages: 6 languages, expanding
  • ๐Ÿฅฝ VR Headsets: 15+ supported devices
  • โ™ฟ Accessibility: WCAG 2.1 AA compliant
  • ๐Ÿ“ฆ Package Formats: DEB, RPM, AppImage, Source
  • ๐Ÿ–ฅ๏ธ Platforms: Linux (x86_64, ARM64)

๐Ÿ“œ License & Credits

License

EGGSHELL is released under the MIT License. See LICENSE for details.

Credits & Acknowledgments

  • Qt Framework: Cross-platform application framework
  • Helyxium Project: Universal VR platform integration
  • Elemental Genius: Educational content platform
  • Material Design: Google's design system
  • OpenVR: VR hardware abstraction layer
  • Community Contributors: Amazing developers worldwide

Special Thanks

  • Educational institutions providing testing feedback
  • VR hardware manufacturers for device support
  • Accessibility advocates for inclusive design guidance
  • Open source community for continuous inspiration

๐Ÿš€ What's Next

Upcoming Features (v2.1)

  • ๐ŸŽ macOS Support: Native Apple Silicon builds
  • ๐ŸชŸ Windows Edition: Windows 10/11 compatibility
  • ๐ŸŽฎ Game Integration: Educational games within VR
  • ๐Ÿ“ฑ Mobile Companion: Android/iOS companion apps
  • ๐Ÿค– AI Tutoring: Intelligent learning assistance
  • ๐Ÿ  Home Edition: Simplified family version

Long-term Vision

  • Global Educational Platform: Worldwide classroom integration
  • AI-Powered Learning: Personalized educational experiences
  • Haptic Integration: Advanced tactile feedback systems
  • Brain-Computer Interface: Future accessibility technologies
  • Metaverse Classrooms: Virtual collaborative learning spaces

๐Ÿ“ž Contact & Links


๐Ÿฅšโœจ Where Young Minds Hatch New Ideas โœจ๐Ÿฅš

Thank you for choosing EGGSHELL!

Revolutionizing education through technology, accessibility, and imagination.

Download EGGSHELL Join Discord Documentation

About

Elemental Genius Custom Linux

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors