The settings window
The five pages are listed down the left side. Previews update as you change things, but nothing is saved until you press Apply or OK. The Help link in the corner opens this page.
Page 1
Periodic breaks
A periodic break takes the last minutes of every cycle. With a 60-minute cycle and a 10-minute break, you work for 50 minutes and rest for 10. The bar at the top of the page draws one cycle like this:
- Enabled
- Turns periodic breaks on or off.
- Cycle length
- One cycle in minutes, break included. The buttons next to the field are common lengths.
- Break for
- How long the break lasts, taken from the end of each cycle.
- Warn me before
- Shows a warning this many minutes before a break. It applies to scheduled breaks too.
- Postpone up to N times, by M min each
- How often, and by how much, you can postpone a break from the warning. Scheduled breaks follow the same limit.
- Align cycles to the clock
- Starts cycles on the hour. When it's off, cycles count from the moment Retreat started.
- Chime when a break ends
- Plays a sound when the break is over. Choose your own sounds on the Break screen page.
- Pause Retreat lasts
- How many hours Disable in the tray menu pauses Retreat for.
Page 2
Scheduled breaks
Scheduled breaks happen at fixed times of day, on top of the regular cycle. The week view at the top shows all of them; click one to select it. Add break creates a new one, which you then edit under the list.
- Enabled
- Turns all scheduled breaks off without deleting them.
- Repeat
- The days of the week. Every day and Weekdays fill them in for you.
- At
- The start time, in hours and minutes.
- For
- How long the break lasts, in minutes.
- Message
- Optional text shown for the whole break, on top of everything else on the break screen, the quote card included.
Custom schedules
Each break is stored as a crontab record, shown in the last column of the list. The settings window only sets days of the week and a time, but you can write other records into the settings file by hand. The five fields are minute, hour, day of the month, month and day of the week.
*/30 9-17 * * *A break every 30 minutes from 9:00 to 17:30, every day.0 12 1,15 * *A break at 12:00 on the 1st and 15th of every month, whatever the day of the week.The list shows these as Custom. Retreat keeps them as written, and only their duration and message can be edited here.
Page 3
Break screen
The preview at the top shows the break with your current settings. Try it for 10 s opens the real break screen for ten seconds without locking anything. Press Esc or click to close it sooner.
- Cover
- Whole screen covers every monitor. A window shows the image in a window of the same size. Without an image, the break always fills the screen with stars.
- Opacity
- How see-through the break screen is. You can also change it during a break with the numpad + and − keys.
- Show countdown
- Shows the time left in the color you pick.
- Position
- One of the four corners or the center. Clicking a spot in the preview works too.
- Size
- S, M, L or XL. M is the default. In a window the countdown is drawn a little smaller.
- Picture
- Random stars draws a new pattern for every break. Images from a folder picks a random JPEG, PNG, GIF or BMP from the folder you choose. For the same image every time, keep only one in the folder.
- Fit
- Fill screen scales the image up to the screen and keeps its proportions. Original size only shrinks images that don't fit.
- Fill around image
- The color of any part of the screen the image doesn't cover.
- Allow transparent regions
- Makes the color of the image's top-left pixel fully transparent, so the desktop shows through wherever that color appears.
- Sound
- A folder of WAV, MP3, WMA or FLAC files to play when a break ends. Leave it empty for the standard system sound. Play plays a sample.
Page 4
Quotes
With quotes turned on, every break shows a picture and a quote on a dark card in the middle of the screen. The preview uses the first quote in the list.
Rest is not idleness.
- Picture
- The Thinker, a drawing of Rodin's sculpture; your own image, chosen with Image... (click it again to pick another); or None for the quote alone.
- Show over
- Break picture keeps the stars or images from the Break screen page around the card. Plain dark puts a dark backdrop behind it instead, dimmed to match the break screen opacity.
- Font, Italic, Color, Size
- How the quote looks. Any installed TrueType font works.
- Random, In order
- How the next quote is picked. In random order, the same quote never comes up twice in a row.
Writing your own quotes
Retreat comes with fifty quotes. Edit the list freely: one quote per line, with the author after a dash that has a space on each side. Any of these dashes works: an em dash (—), an en dash (–), a double hyphen (--) or a plain hyphen (-). If a line has several, the author starts after the last one. Empty lines are skipped. If the list is empty, the card shows only the picture.
Rest is not idleness. - John Lubbock
Page 5
Exceptions
Retreat can skip a break on its own in two situations. Each one is turned on separately.
You were already away
If there was no keyboard or mouse input for the time set with Away for at least, right before the warning, you've had your break and Retreat skips it.
A listed program is running
Retreat won't lock the screen while any program on the list is open. Add programs with Pick from running programs or Browse for .exe. The list marks the ones running right now.
During a break
Make the break screen more or less opaque, so you can keep an eye on a download or a build.
Closes the ten-second preview started with Try it for 10 s. Clicking anywhere does the same.