README

A Flarum extension that adds a touch of magic to your site with visual enhancements and fun effects.

Русская версия

Features

Scroll Progress Bar

A thin progress bar below the header that fills as you scroll down the page. Matches your site's primary color.

Back to Top Button

A floating button that appears after scrolling down. Click it to smoothly scroll back to the top.

Choose between circle or rounded square shape
Use any FontAwesome icon (e.g. fa-solid fa-chevron-up, fa-solid fa-angle-double-up)

Custom Scrollbar

Replaces the default browser scrollbar with a thin, themed one that matches your site colors.

Click Spark

A burst of sparkles from your cursor on every click. A fun little touch that adds magic to the whole site.

Swap Sidebar & Content

Moves the sidebar to the right and discussion list to the left, giving your forum a unique layout.

Background Patterns

Subtle background patterns that work on both light and dark themes:

Dots
Grid
Diagonal lines
Waves
Hexagons

Per-Feature Accent Colors

Each colored feature is individually customizable and defaults to your forum's color when left empty:

Progress bar color
Back to top button color
Custom scrollbar color
Click spark color

Accepts any CSS color, e.g. #00a185, red, rgb(255, 0, 0) — or leave empty to use your forum color.

Falling effects

Every falling effect has 3 density levels — Light, Medium and Heavy.

Falling Snow

Animated falling snowflakes across the entire site. Perfect for the holiday season.

Density: Light (25 flakes), Medium (50 flakes), Heavy (75 flakes)

Falling Leaves

Animated autumn leaves drifting across the entire site.

Density: Light (10 leaves), Medium (25 leaves), Heavy (40 leaves)

Falling Rain

A rain effect with falling raindrops across the entire site. Color adapts to the site theme.

Density: Light (40 drops), Medium (80 drops), Heavy (140 drops)

Cherry Blossom Petals

Spring cherry blossom petals drifting across the entire site.

Density: Light (12 petals), Medium (24 petals), Heavy (40 petals)

Confetti

Colorful confetti falling for celebrations and parties.

Density: Light (20 pieces), Medium (40 pieces), Heavy (60 pieces)

Floating Hearts

Hearts floating up for Valentine's Day.

Density: Light (10 hearts), Medium (20 hearts), Heavy (35 hearts)

Four-Leaf Clovers

Spinning four-leaf clovers for St. Patrick's Day.

Density: Light (12 clovers), Medium (25 clovers), Heavy (40 clovers)

Easter Eggs

Bouncing Easter eggs across the site for Easter.

Density: Light (8 eggs), Medium (15 eggs), Heavy (25 eggs)

Chinese New Year

Red lanterns, dragons and lucky charms for Chinese New Year.

Density: Light (10 lanterns), Medium (20 lanterns), Heavy (35 lanterns)

Fireflies

Glowing fireflies rising through a summer night.

Density: Light (12 fireflies), Medium (25 fireflies), Heavy (40 fireflies)

Custom Effects

Create your own effects from your own emojis. Two slots are available:

Custom (Up) — particles rise upward like fireflies
Custom (Down) — particles fall downward like snow or confetti

For each slot you can configure:

Enabled toggle
Emojis (space- or comma-separated), e.g. 🎄 🎁 ⭐ 🎈
Particle count (1–100)

Both custom effects are also available in the Scheduler. Get emojis from emojipedia.org.

Disable Effects per User

Each user can turn all falling effects off from their own Settings → Effects page. Admins enable/disable this option itself from the admin Effects section.

Scheduler

Automatically enable effects during a specific period of time. Create a schedule with a title, start and end date, pick the effects (each with its own density) and enable it — the effects will show whenever the schedule is active, even if the manual toggle is off.

Installation

composer require stezkoy/flarum-time-of-magic

Requirements

Flarum 2.0
PHP 8.3+

Configuration

All features are configurable via Admin > Extensions > Time of Magic. Each feature can be toggled on/off independently.

License

MIT

stezkoy / flarum-time-of-magic

Package info

Security

Statistics