Home.md

MouseEffects Wiki

Welcome to the MouseEffects documentation. This wiki provides comprehensive guides for users and developers.

User Guide

• Features Overview - Learn about all application features
• Auto-Updates - Automatic update system and configuration
• Plugins Reference - Detailed documentation for each effect plugin

Developer Guide

• Architecture - Technical architecture and design patterns
• Building from Source - How to build the application
• GitHub Actions CI/CD - Automated builds and releases
• Workflow File Reference - Line-by-line release.yml explanation
• MSIX Packaging - Creating MSIX distributable packages
• Velopack Packaging - Creating portable installer with auto-updates
• Certificate Management - Code signing certificates

Plugin Development

• Creating Basic Plugins - Build effects without screen capture
• Screen Capture Plugins - Build effects that transform screen content

Quick Links

Topic	Description
System Requirements	Hardware and software requirements
Installation	How to install MouseEffects
Configuration	Where settings are stored

System Requirements

Minimum Requirements

• Operating System: Windows 10 version 1803 (April 2018 Update) or later
• Graphics: DirectX 11 compatible GPU
• Memory: 4 GB RAM
• Storage: 50 MB available space

Recommended

• Operating System: Windows 11
• Graphics: Dedicated GPU with 2+ GB VRAM
• Memory: 8 GB RAM

Installation

Velopack Installer (Recommended)

1. Download MouseEffects-win-Setup.exe from Releases
2. Run the installer - no administrator rights required
3. The app installs to %LocalAppData%\MouseEffects and updates automatically

MSIX Package (Enterprise/Store)

1. Download the latest .msix from releases
2. Install the developer certificate (if not using a trusted certificate)
3. Double-click the .msix file

Portable Version

1. Download MouseEffects-{version}-win-full.nupkg from releases
2. Rename to .zip and extract to any folder
3. Run MouseEffects.App.exe

From Source

1. Clone the repository
2. Build with dotnet build
3. Run MouseEffects.App.exe

Configuration

Settings are stored in:

%APPDATA%\MouseEffects\
├── settings.json           # Application settings
└── plugins\
    ├── particle-trail.json # Per-plugin settings
    ├── laser-work.json
    └── ...

Application Settings

Setting	Type	Default	Description
SelectedGpuName	string	null	GPU to use (null = auto)
TargetFrameRate	int	60	Frame rate limit (30-120)
ShowFpsCounter	bool	false	Show FPS in settings window
ShowFpsOverlay	bool	false	Show FPS on screen overlay
UpdateCheckFrequency	string	OnStartup	When to check: OnStartup, Daily, Weekly, Never
UpdateMode	string	Notify	How to handle updates: Silent, Notify
IncludePreReleases	bool	false	Include pre-release versions
LastUpdateCheck	DateTime	null	Last update check timestamp

Getting Help

• Check the Plugins Reference for effect-specific settings
• Review the Architecture for technical details
• Open an issue on GitHub for bugs or feature requests