/retro-frame

Primary LanguageJavaScriptMIT LicenseMIT

Retro Frame

DIY pixel art frame, inspired by Game Frame.

Retro Frame photo showing Mario chasing a gumba Retro Frame photo showing Hollow Knight

mario.mp4
hk.mp4

Intro

The brain is Adafruit MatrixPortal M4, an ESP32-based controller. You'll need to follow Adafruit's documentation to install CircuitPython. Then you can copy the code (don't forget to create src/settings.py).

Files you'll need to copy to your MatrixPortal are:

Rename src/settings_example.py to src/settings.py. If you want the frame to connect to the internet in order to fetch the correct time, add your network name, password, and set skip_connection=False.

Then copy the following files and folders:

  • code.py and src/*.py (see copy.bat|sh)
  • firmware/[current_version]/lib to lib
  • assets (which includes splash screen and digital clock sprite)
  • gif (pick and choose animations you like)

Apps

There are four apps:

  • Gif player (runs each animation for 5 minutes then switches to the next one)
  • Digital clock (needs internet connection to get time)
  • Analogue clock (needs internet connection to get time)
  • Blank - used to preserve power during the night

By default, the display will switch to the digital clock at 23:30, to blank at midnight, and to gif player at 8:30 in the morning. Check src/settings_example.py, copy it to src/settings.py, and update it to your preferences.

Controls

Tilting the display left and right will cycle between the apps (button up will do the same).

Tilting the display back and forward will (button down will do the same):

  • Gif app - switch between gifs
  • Digital clock - switch between 12 and 24 hours clock modes
Digital Clock Analogue Clock
Retro Frame with digital clock app showing Retro Frame with analogue clock app showing

List of parts

This is a list of all of the main parts with the links to the ones we used.

Retro Frame internals

Similar projects

There is a few similar projects you might want to check out:

Art credits

If I included your art and you want it removed, I'm sorry, just open an issue and I'll take care of it. The only reason I included your work in the first place is because it is awesome and it makes me happy.

Other people:

Myself

  • Splash screen
  • Clock digits
  • Pulsar animations
  • Totoro - heavily inspired by this one
  • Tutur, in loving a memory of Artur <3