Skip to content

ghenry22/Photoprism-saver

Repository files navigation

Photoprism Screensaver

A Windows screensaver that displays a slideshow of photos from your Photoprism server.

This is project is under active development, things will break as new features are added. If you have issues try grabbing an older release.

Features

  • Fetch photos from Photoprism via API
  • Secure credential storage using Windows Credential Manager
  • Filter photos by:
    • Albums (multi-select)
    • Year and month
    • Favorites only
    • Exclude NSFW content
    • Random selection
  • Full-screen slideshow with smooth transitions
  • Photo caching for offline viewing
  • Preview mode support

Installation

First-Time Installation

  1. Download the latest release from the Releases page
  2. Extract the ZIP file
  3. Right-click PhotoprismSaver.scr and select "Install"
    • Note: Windows SmartScreen may show a warning because the app isn't code-signed yet
    • Click "More info" then "Run anyway" to proceed with installation
    • This warning only appears once during installation
  4. Configure via Display Settings > Screen Saver > Settings

Alternative: Manually copy PhotoprismSaver.scr to C:\Windows\System32

For information about code signing and eliminating the SmartScreen warning, see CODE_SIGNING.md.

Configuration

Right-click the .scr file and select "Configure" or use the Settings button in Display Properties to:

  • Set your Photoprism server URL
  • Manage credentials securely
  • Select albums and filters
  • Configure slideshow preferences

Building

Requirements:

  • .NET 6.0 SDK or later
  • Windows 10/11
dotnet restore
dotnet build -c Release

The built .scr file will be in bin/Release/net6.0-windows/

Development

  • Program.cs - Entry point and command-line argument handling
  • ScreensaverForm.cs - Full-screen slideshow display
  • ConfigForm.cs - Configuration dialog
  • PreviewForm.cs - Preview mode for Display Properties
  • PhotoprismClient.cs - Photoprism API integration
  • Settings.cs - Settings management (Registry)
  • Models/ - Data models for API responses

License

MIT License

About

A Windows Screensaver that pulls photos from your Photoprism server

Topics

Resources

License

Stars

Watchers

Forks

Contributors