Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

HautlyS/mouse-spark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒŠ Splash Cursor - Enhanced Fluid Mouse Effects Extension

Transform your cursor into beautiful, mesmerizing fluid animations that follow your mouse movement across any webpage. This enhanced version includes improved performance, cross-browser compatibility, and extensive customization options.

โœจ Features

Core Features

  • Fluid Simulation: Real-time WebGL-powered fluid dynamics
  • Mouse Tracking: Smooth, responsive cursor following
  • Color Animation: Dynamic color transitions and effects
  • Cross-Browser: Works on Chrome, Firefox, Edge, and other Chromium browsers
  • Performance Optimized: Adaptive quality and efficient rendering

New Enhanced Features

  • ๐ŸŽ›๏ธ Advanced Settings Panel: Intensity, color speed, and quality controls
  • โšก Performance Mode: Optimized settings for lower-end devices
  • ๐Ÿ”ง Auto Quality Adjustment: Adapts to your device's performance
  • ๐Ÿ“ฑ Mobile Support: Touch-friendly interactions
  • ๐ŸŒ Domain Exclusions: Disable on specific websites
  • โŒจ๏ธ Keyboard Shortcuts: Quick toggle and control
  • ๐Ÿ’พ Settings Persistence: Your preferences are saved
  • ๐Ÿ” Context Menu: Right-click controls
  • ๐Ÿš€ Better Error Recovery: Robust error handling

๐Ÿ”ง Installation

For Chrome/Edge (Manifest V3)

  1. Download the extension files
  2. Open Chrome Extensions page:
    • Go to chrome://extensions/
    • Enable "Developer mode" (top right toggle)
  3. Load the extension:
    • Click "Load unpacked"
    • Select the folder containing the extension files
    • Make sure you're using manifest.json (not manifest_v2.json)

For Firefox (Manifest V2)

  1. Prepare Firefox version:
    • Rename manifest_v2.json to manifest.json
    • Remove the original manifest.json
  2. Load in Firefox:
    • Go to about:debugging
    • Click "This Firefox"
    • Click "Load Temporary Add-on"
    • Select the manifest.json file

For Development

# Clone or download the repository
git clone https://github.com/splash-cursor/extension.git
cd splash-cursor-extension

# For Chrome development
cp manifest.json manifest_chrome.json

# For Firefox development  
cp manifest_v2.json manifest.json

๐Ÿ“ File Structure

splash-cursor-extension/
โ”œโ”€โ”€ manifest.json              # Chrome/Edge Manifest V3
โ”œโ”€โ”€ manifest_v2.json          # Firefox Manifest V2
โ”œโ”€โ”€ content.js                # Enhanced content script
โ”œโ”€โ”€ background.js             # Enhanced background script  
โ”œโ”€โ”€ popup.html               # Enhanced popup interface
โ”œโ”€โ”€ popup.js                 # Enhanced popup logic
โ”œโ”€โ”€ options.html             # Settings page (optional)
โ”œโ”€โ”€ options.js               # Settings page logic (optional)
โ”œโ”€โ”€ icons/                   # Extension icons
โ”‚   โ”œโ”€โ”€ icon16.png
โ”‚   โ”œโ”€โ”€ icon32.png  
โ”‚   โ”œโ”€โ”€ icon48.png
โ”‚   โ”œโ”€โ”€ icon96.png
โ”‚   โ””โ”€โ”€ icon128.png
โ””โ”€โ”€ README.md               # This file

๐ŸŽฎ Usage

Basic Usage

  1. Click the extension icon in your browser toolbar
  2. Toggle the effect using the "Enable/Disable" button
  3. Move your mouse to see the fluid animation
  4. Adjust settings using the settings panel

Settings Panel

  • Intensity: Control the strength of the fluid effect (0-100%)
  • Color Speed: How fast colors change and transition (0-100%)
  • Fluid Quality: Resolution and detail level (25-100%)
  • Performance Mode: Enable for better performance on slower devices

Keyboard Shortcuts

  • Ctrl+Shift+S (Windows/Linux) or Cmd+Shift+S (Mac): Toggle effect
  • Right-click context menu for quick access

Advanced Features

  • Domain Exclusions: Right-click โ†’ "Exclude this domain"
  • Auto-disable: Automatically disables on restricted pages
  • Performance Monitoring: Auto-adjusts quality based on FPS

โš™๏ธ Configuration

Default Settings

{
  enabled: true,
  intensity: 50,        // Effect strength (0-100)
  colorSpeed: 50,       // Color change speed (0-100)  
  fluidQuality: 75,     // Rendering quality (25-100)
  performance: false    // Performance mode
}

Performance Tuning

For High-End Devices:

  • Quality: 90-100%
  • Performance Mode: Off
  • Intensity: 70-100%

For Low-End Devices:

  • Quality: 25-50%
  • Performance Mode: On
  • Intensity: 20-50%

๐Ÿš€ Technical Details

WebGL Requirements

  • WebGL 1.0 minimum (WebGL 2.0 preferred)
  • Hardware acceleration recommended
  • Modern browser (Chrome 88+, Firefox 78+, Edge 88+)

Performance Features

  • Adaptive Quality: Automatically adjusts based on FPS
  • Frame Rate Monitoring: Tracks performance in real-time
  • Resource Cleanup: Proper memory management
  • Error Recovery: Graceful handling of WebGL context loss

Browser Compatibility

  • โœ… Chrome 88+
  • โœ… Firefox 78+
  • โœ… Edge 88+
  • โœ… Opera 74+
  • โœ… Safari 14+ (limited support)

๐Ÿ› Troubleshooting

Common Issues

Effect not working:

  • Check if WebGL is enabled in your browser
  • Ensure hardware acceleration is enabled
  • Try refreshing the page
  • Check browser console for errors

Performance issues:

  • Enable Performance Mode in settings
  • Lower the Fluid Quality setting
  • Close other resource-intensive tabs
  • Update your graphics drivers

Extension not loading:

  • Verify all files are in the correct directory
  • Check for JavaScript errors in developer tools
  • Ensure you're using the correct manifest version
  • Try reloading the extension

Browser-Specific Issues

Chrome/Edge:

  • Use manifest.json (Manifest V3)
  • Check that "Developer mode" is enabled

Firefox:

  • Use manifest_v2.json renamed to manifest.json
  • Load as temporary add-on for testing

Console Debugging

Open browser developer tools (F12) and check for errors:

// Check WebGL support
console.log('WebGL supported:', !!document.createElement('canvas').getContext('webgl'));

// Monitor performance
console.log('Current FPS:', performance.currentFps);

๐Ÿ”’ Permissions Explained

  • Storage: Save your settings and preferences
  • ActiveTab: Access the current tab for the effect
  • ContextMenus: Right-click menu options
  • Host Permissions: Apply effects to all websites
  • Tabs (optional): Enhanced tab management
  • WebNavigation (optional): Domain exclusion features

๐Ÿค Contributing

Development Setup

  1. Fork the repository
  2. Make your changes
  3. Test on multiple browsers
  4. Submit a pull request

Code Style

  • Use modern JavaScript (ES6+)
  • Add comprehensive error handling
  • Include performance optimizations
  • Write clear comments and documentation

Testing Checklist

  • Chrome compatibility
  • Firefox compatibility
  • Mobile/touch support
  • Performance on low-end devices
  • Error recovery scenarios
  • Settings persistence

๐Ÿ“ Changelog

Version 2.0.0

  • โœ… Complete rewrite with enhanced architecture
  • โœ… Cross-browser compatibility (Chrome + Firefox)
  • โœ… Advanced settings panel with real-time controls
  • โœ… Performance monitoring and auto-optimization
  • โœ… Improved error handling and recovery
  • โœ… Touch support for mobile devices
  • โœ… Domain exclusion system
  • โœ… Context menu integration
  • โœ… Keyboard shortcuts
  • โœ… Better WebGL resource management

Version 1.0.0

  • โœ… Basic fluid simulation
  • โœ… Mouse tracking
  • โœ… Simple toggle functionality

๐Ÿ™ Acknowledgments

  • WebGL fluid simulation techniques
  • Cross-browser extension development practices
  • Performance optimization strategies
  • Community feedback and testing

๐Ÿ“„ License

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

๐Ÿ”— Links


Made with โค๏ธ for a more beautiful web experience

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published