Weather Effect GNOME Extension

Description

Weather Effect is a GNOME Shell extension that adds beautiful animated weather effects (snow or rain) to your desktop wallpaper or as a full-screen overlay. Enjoy the magic of falling snowflakes or raindrops on your GNOME desktop!

Key Features:

• ❄️ Snow Effect: Beautiful animated snowflakes falling on your desktop
• 🌧️ Rain Effect: Realistic rain animation with customizable particles
• Display Modes:
  • Wallpaper Mode: Effects only on desktop wallpaper background
  • Screen Mode: Full-screen overlay that works even in overview
• Customizable Settings:
  • Particle count (5-50)
  • Particle size (4-32 pixels)
  • Speed control (Slow, Medium, Fast)
  • Color customization for snow and rain
  • Custom emoji support (❄, ❅, ❆, 💧)
• Multi-Monitor Support: Automatically works across all connected monitors
• Smart Behavior: Pauses when desktop is obscured by fullscreen windows
• Quick Settings Integration: Easy access through GNOME Quick Settings menu

Installation

Prerequisites

• GNOME Shell 45-49
• Git (for cloning the repository)

Quick Installation

1. Clone the repository:

   git clone https://github.com/quinsaiz/weather-effect.git
   cd weather-effect

2. Make the install script executable:

   chmod +x install.sh

3. Run the installation script:

   ./install.sh

4. Enable the extension:

   • Log out and log back in
   • Open GNOME Extensions app
   • Find "Weather Effect" and enable it

Building from Source

If you want to build the extension from source code, follow these steps:

Prerequisites for Building

• Node.js (v16 or higher) - Download
• npm (comes with Node.js)
• TypeScript (installed via npm)
• glib-compile-schemas (usually comes with GNOME development packages)

On Ubuntu/Debian:

sudo apt install nodejs npm gir1.2-glib-2.0

On Fedora:

sudo dnf install nodejs npm glib2-devel

On Arch:

sudo pacman -S nodejs npm glib2

Build Steps

1. Clone the repository:

   git clone https://github.com/quinsaiz/weather-effect.git
   cd weather-effect

2. Install dependencies:

   npm i

3. Build the extension:

   npm run build

   This will:

   • Compile TypeScript files to JavaScript
   • Compile GNOME settings schemas
   • Copy compiled files to gnome extensions folder

Development Mode

For continuous development with auto-rebuild:

npm run watch

This will watch for file changes and automatically rebuild the extension.

Usage

1. Open Quick Settings by clicking the system menu in the top-right corner
2. Click the Weather Effect toggle (weather icon)
3. Select effect type:
   • Choose between Snow ❄️ or Rain 🌧️ using the horizontal selector buttons
4. Configure settings (optional):
   • Open GNOME Extensions app
   • Click the ⚙️ gear icon next to Weather Effect
   • Adjust particle count, size, speed, colors, and display mode

Project Structure

weather-effect/
│
├── src/
│   ├── extension.ts      # Main extension code (TypeScript)
│   └── prefs.ts          # Preferences window code (TypeScript)
│
├── schemas/
│   └── org.gnome.shell.extensions.weather-effect.gschema.xml  # Settings schema
│
├── extension.js          # Compiled main extension (JavaScript)
├── prefs.js              # Compiled preferences (JavaScript)
├── metadata.json         # Extension metadata
├── install.sh            # Installation script
├── package.json          # Node.js dependencies
├── tsconfig.json         # TypeScript configuration
├── LICENSE               # GPLv3 License
└── README.md             # This file

Configuration

The extension can be configured through the GNOME Extensions app settings:

• Effect Type: Snow or Rain
• Display Mode: Wallpaper only or Full screen overlay
• Particle Count: 5 to 50 particles
• Particle Size: 4 to 32 pixels
• Speed: Slow, Medium, or Fast
• Snow Color: White, Light Blue, or Silver
• Rain Color: Gray or Dark Blue
• Custom Emojis: Choose custom emoji or use default shapes

Author

quinsaiz

GitHub: https://github.com/quinsaiz

License

This project is licensed under the GPLv3 License.

Support

If you like this project, please give it a star on GitHub!

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.