From 457a449019a0600a07bbb850fcd26f7061d62a23 Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Sun, 22 Feb 2026 13:55:10 +0100 Subject: [PATCH] docs(compliments): clarify remoteFile path resolution and limitations --- modules/compliments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/compliments.md b/modules/compliments.md index 4be45362..4ff387f4 100644 --- a/modules/compliments.md +++ b/modules/compliments.md @@ -33,7 +33,7 @@ The following properties can be configured: | `updateInterval` | How often does the compliment have to change? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `30000` (30 seconds) | | `fadeSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `4000` (4 seconds) | | `compliments` | The list of compliments.

**Possible values:** An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. See _compliment configuration_ below.
**Default value:** See _compliment configuration_ below. | -| `remoteFile` | External file from which to load the compliments

**Possible values:** Path or URL (starting with `http://` or `https://`) to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An json object {} with at least one of the arrays: `morning`, `afternoon`, `evening`, `anytime`, `datetype` and/or `crontype`. - `compliments.json`
**Default value:** `null` (Do not load from file) | +| `remoteFile` | External file from which to load the compliments

**Possible values:** URL (starting with `http://` or `https://`) or a **relative path** to a JSON file containing compliments. A relative path is resolved relative to the compliments module directory (`modules/default/compliments/`), so a file placed in the MagicMirror root would be referenced as `"../../compliments.json"`. Absolute filesystem paths are not supported.

The JSON file must contain an object with at least one of the arrays: `morning`, `afternoon`, `evening`, `anytime`, `datetype` and/or `crontype`.
**Default value:** `null` (Do not load from file) | | `remoteFileRefreshInterval` | How often to reload the remote file, if remoteFile is specified. in ms
**Default value:** 0
**Minimum value:** 15 minutes (15\*60\*1000) | | `classes` | Override the CSS classes of the div showing the compliments

**Default value:** `thin xlarge bright` | | `morningStartTime` | Time in hours (in 24 format), after which the mode of "morning" will begin
**Possible values:** `0` - `24`

**Default value:** `3` |