Skip to content

Commit a2d83a7

Browse files
committed
docs
1 parent 69fca6f commit a2d83a7

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

docs/faq/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ Changed options are stored inside `config/my.config.inc.php` to prevent sharing
4040

4141
---
4242

43+
## How do I set up the screensaver?
44+
45+
Use the Admin Panel → General → Screensaver and follow [Screensaver function](screensaver.md) for modes, file locations, and timing tips.
46+
47+
---
48+
4349
## How to change the language?
4450

4551
Open [http://localhost/admin](http://localhost/admin) (

docs/faq/screensaver.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Screensaver function
2+
3+
The screensaver keeps the start screen fresh and prevents burn‑in when guests are idle. Configure it in the Admin Panel under **General → Screensaver**.
4+
5+
## What it can show
6+
7+
- **Image**: Display a single image. Use `Screensaver image path`.
8+
- **Video**: Loop a single video. Use `Screensaver video path`.
9+
- **Folder**: Cycle through files in `private/screensavers/`. Supported: `.jpg`, `.png`, `.gif`, `.mp4`, `.webm`.
10+
- **Gallery**: Cycle through gallery photos guests already took; falls back to the image path if the gallery is empty.
11+
12+
## Text overlay
13+
14+
- Optional **Screensaver text** shows on top of the media.
15+
- Choose **Text position** (`top`, `bottom`, `center`) to avoid covering key visuals.
16+
- In Gallery mode the overlay alternates between your text and event text to avoid screen burn.
17+
18+
## Timing
19+
20+
- **Timeout before screensaver**: minutes of no interaction before it starts. Set to `0` to keep the screensaver off even if enabled.
21+
- **Slide change interval**: minutes between media switches in Folder or Gallery mode. Has no effect for single image/video modes.
22+
- Any click or touch hides the screensaver and resets the timer.

mkdocs_remote.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ nav:
4444
- Custom collage design: faq/custom-collage.md
4545
- Kiosk mode: faq/kiosk-mode.md
4646
- Hide cursor & screen blanking: faq/hide-cursor.md
47+
- Screensaver: faq/screensaver.md
4748
- Tutorials: faq/tutorials.md
4849
- Remote Buttons: faq/remote-button.md
4950
- Printer Troubleshooting: faq/printer-troubleshooting.md

0 commit comments

Comments
 (0)