Skip to content

A minimal screensaver to display animated sprites. Implemented as an XScreenSaver module.

License

Notifications You must be signed in to change notification settings

henrynoyes/spritesaver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

Overview

SpriteSaver is a screensaver for displaying animated sprites. It is designed to be minimal, inspired by the familiar bouncing DVD logo. It is configured as a module in XScreenSaver with settings to adjust the movement speed and animation delay.

Gallery

aerodactyl mew
magneton moltres

Installation

Note

This software was developed and tested on Ubuntu 22.04. Support for other platforms is listed in Future Features.

First, install XScreenSaver and FFmpeg if they are not installed already,

sudo apt install xscreensaver ffmpeg

Then clone and run configure.sh. This only needs to be run once as long as XScreenSaver is not uninstalled.

git clone [email protected]:henrynoyes/spritesaver.git
cd spritesaver && sudo ./configure.sh

Importing Sprites

Find a pair of sprites in GIF format and place them in a new directory inside sprites/. Make sure both GIFs contain the same number of frames.

Tip

For detailed instructions on installing Pokémon sprites, see POKEMON.md.

Autobuild with Docker

To use autobuild.sh, make sure you have a working Docker installation. Then simply run,

sudo ./autobuild.sh sprites/sprite_name/left.gif sprites/sprite_name/right.gif

Open the XScreenSaver GUI by launching the Screensaver application or running the xscreensaver-demo command. Select SpriteSaver and modify the desired settings.

To preview SpriteSaver, you can manually activate XScreenSaver with,

xscreensaver-command -activate

It can also be previewed in a floating window by running the binary,

./sprites/spritesaver

Note

To view all installation methods, see INSTALLATION.md.

Future Features

  • Add support for walking sprites (random movements along bottom of the screen)
  • Add support for floating sprites (slowly float in regions around screen)
  • Add support for multiple sprites at once (allow for any combination of flying/walking/floating)
  • Add adjustable frame rate in settings
  • Test compatibility with other platforms (Ubuntu 20.04, macOS)

About

A minimal screensaver to display animated sprites. Implemented as an XScreenSaver module.

Resources

License

Stars

Watchers

Forks