Skip to content

Famous Windows "Ribbons" inspired screensaver made with JavaScript and Electron, supporting multiple platforms.

License

Notifications You must be signed in to change notification settings

drlight17/ribbons-electron

Repository files navigation

Ribbons Screensaver

Famous windows-like Ribbons screensaver made with js and Electron wrapped for multi platform support

Minimum OS requirements

MacOS 10.15 Catalina (since 0.2.2-alpha), Windows 8/2012, Linux with modern kernel version (5.x) and Xserver (wayland is not supported, at least for now)

📦 Download and install

Go to landing page https://drlight17.github.io/, download your platform latest version and follow installation


Supported settings

All app settings are saved in the local user folder in file config.json:

  • Windows 8 and newer: %AppData%\Ribbons screensaver
  • Linux ~/.config/Ribbons screensaver
  • MacOS: ~/Library/Application Support/Ribbons screensaver

Usage

This app is created to be used as screensaver with idle system detect to run fullscreen animation. For current alpha version it isn't supposed to be:

  • "native" windows scr app as there are no native winapi preview and settings implementation
  • "native" linux xscreensaver app as there are no plans to develop something for xscreensaver api
  • "native" macos screensaver app as there are no plans to develop something for Objective-C and Cocoa framework

So for all the platforms make sure to disable "native" screensaver to prevent conflicts!

After app startup check it's settings in tray menu:

For developers

Build depends on the platform as it uses the system idle detect function.

For Windows:

choco install python312 visualstudio2019community visualstudio2019-workload-nativedesktop visualstudio2019buildtools windows-sdk-10.0
pip install setuptools

For Linux:

apt install libxss-dev pkg-config

Platform independent steps:

git clone https://github.com/drlight17/ribbons-electron
cd ./ribbons-electron
npm install -g node-gyp
npm install --save-dev electron-rebuild
npx electron-rebuild

To run dev app use:

npm start

In dev mode config path includes '-dev'

To build all platform distributives at once use:

npm run dist

Or you can build specific dist. For example linux rpm package:

npm run build-rpm

If there are any module errors try to npx electron-rebuild before every npm start or npm run dist.

Also check package.json

Special thanks to:

All rights belongs to their authors!

About

Famous Windows "Ribbons" inspired screensaver made with JavaScript and Electron, supporting multiple platforms.

Resources

License

Stars

Watchers

Forks

Languages