An awesome way to display your photos as an digital photo frame
Explore immich »
Report Bug
·
Request Feature
This project is not affiliated with immich!
This project is a digital photo frame application that interfaces with your immich server. It is a cross-platform C# .NET 7 project that currently supports Linux, macOS, and Windows.
ImmichFrame is easy to run on your desired plattform.
- A set up and functioning immich server
Important
Make sure to copy the Settings.example.xml and name it Settings.xml
- Get the latest release from the release page and unzip
- Rename the
Settings.example.xml
file toSettings.xml
- Change
<ImmichServerUrl>
to your domain or local ip<ImmichServerUrl>http://yourdomain.com</ImmichServerUrl>
- Change
<ApiKey>
. Read more about immich ApiKey here: https://immich.app/docs/features/command-line-interface#obtain-the-api-key<ApiKey>YourApiKey</ApiKey>
- Optional: Choose albums you would like to display
<Albums> <Album>First Album UID</Album> <Album>Second Album UID</Album> </Albums>
- Optional: Choose people you would like to display
<People> <Album>First person UID</Album> <Album>Second person UID</Album> </People>
- Adjust other settings to your needs
- GUI - Double-click Immich_Frame.
- CLI - CD into folder, and launch with "./Immich_Frame".
- SSH - CD into folder, and launch with "DISPLAY=:0.0 ./Immich_Frame".
- Double-click Immich_Frame.
- Screensaver - Rename Immich_Frame.exe to Immich_Frame.scr. Right-click-Install. Configure screensaver settings and apply. Note: you will still have to click middle/bottom in the app to exit screensaver.
- Double-click Immich_Frame. Note: If nothing happens, right-click-open with-Utilities-Terminal. Check Always Open With.
The screen is configured in a 3x3 gird
- | - | - |
---|---|---|
A | - | B |
- | C | - |
Touch or click to:
A. Go back to last image
B. Next random image
C. Quit
- Display random assets
- Display Albums
- Display Memories
- Android build
- Add Additional Templates w/ Examples
- Add License
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
TODO
TODO
BIG thanks to the immich-team for creating an awesome tool