Skip to content
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Each release's installer and full notes are on [GitHub Releases](https://github.com/Xarishark/Director/releases).

## Unreleased

- **Updates**: Director checks GitHub for a newer version when the window opens and offers **Install update**, which downloads setup, verifies its SHA-256 checksum and starts it. Turn the check off or check by hand in **Options → About**; `director update [--install]` does the same from a terminal.

## 0.13.0 (2026-11-08)

- Director is open source under the **MIT License**. The installer adds `LICENSE.txt` and the third-party notices beside the app.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Director talks to Windows, the NVIDIA driver, RTSS and your TV directly, from on

## Install

Director needs **Windows 11, version 24H2 or newer** (x64), because switching HDR per screen uses display APIs that Windows added in 24H2. Download **Director-x64-setup.exe** with the button above and run it. Setup installs the Windows App Runtime if it's missing and adds `director` to PATH. See [Install](docs/INSTALL.md) for quiet installs, updates and uninstalling.
Director needs **Windows 11, version 24H2 or newer** (x64), because switching HDR per screen uses display APIs that Windows added in 24H2. Download **Director-x64-setup.exe** with the button above and run it. Setup installs the Windows App Runtime if it's missing and adds `director` to PATH. Director tells you when a new version is out and installs it in a click. See [Install](docs/INSTALL.md) for quiet installs, updates and uninstalling.

## Quick start

Expand Down
1 change: 1 addition & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Director runs locally and controls devices on your home network. Areas where a b
- **TV connections**: the TLS connection and certificate checks for Android TV Remote v2, certificate pinning for LG and Samsung, and parsing anything a device on the network sends back.
- **Local data**: settings, backups and reports written to disk, and what crash reports and the **Report on GitHub** link include.
- **The installer**: `setup.exe` downloads the Windows App Runtime from Microsoft and checks its SHA-512 hash before running it.
- **Updates**: Director downloads setup only from this repository's GitHub releases, over HTTPS, and runs it only if its SHA-256 matches the digest GitHub reports for the release asset.
- **The `director-run:` link handler** that the installer registers.

Director's own design assumes a trusted home network. Problems that need an attacker who already controls the PC or the Windows account are out of scope.
8 changes: 7 additions & 1 deletion docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,13 @@ From an elevated terminal:

## Update

Download and run the newer setup. It replaces the installed version and keeps your settings. `director --version` or **Options → About** shows the installed version.
When you open the window, Director asks GitHub for the latest release. If there's a newer one, a bar at the bottom of the Scenes page offers **Install update**. Director downloads setup with a progress bar, checks it against the SHA-256 checksum GitHub publishes for the release, starts it and closes so setup can replace the files. Confirm the Windows prompt; setup shows only its progress, with nothing to click, and Director reopens when it's done. Your settings and desktop shortcut stay as they are. If you cancel the prompt or setup fails, Director stays closed and offers the update again next time. Nothing is downloaded or installed until you choose it.

- **Options → About** has **Check for updates** and the switch for the check at startup. With the switch off, Director contacts GitHub only when you ask.
- From a terminal: `director update` says whether a newer version exists; `director update --install` downloads, verifies and starts setup (it doesn't reopen the window). Commands never check on their own, so shortcuts and Stream Deck buttons stay offline.
- You can still download and run the newer setup yourself. `director --version` or **Options → About** shows the installed version.

A copy that isn't the installed one (for example a build from source) offers **Download** instead, which opens the release page.

## Uninstall

Expand Down
7 changes: 7 additions & 0 deletions src/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ FPS
director fps status
director fps set <nvidia|rtss> <FPS|vrr|off>

Updates
director update Check GitHub for a newer version
director update --install Download it, verify its checksum and start setup

director --version

Without arguments, opens the window. Leaving out the device in an audio command means the
Expand Down Expand Up @@ -108,6 +112,9 @@ pub fn run(args: &[String]) -> i32 {
if args.first().is_some_and(|area| area == "fps") {
return crate::fps::windows_fps::cli(&args[1..]);
}
if args.first().is_some_and(|area| area == "update") {
return crate::update::cli(&args[1..]);
}
if args.first().is_some_and(|area| area == "audio") {
return crate::audio::audio_cli::run(&args[1..]);
}
Expand Down
1 change: 1 addition & 0 deletions src/gui/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ pub(crate) mod tv_power_state;
pub(crate) mod tv_tip_ui;
pub(crate) mod tv_ui;
pub(crate) mod ui;
pub(crate) mod update_ui;
15 changes: 9 additions & 6 deletions src/gui/options_ui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -436,13 +436,16 @@ impl DirectorApp {
"About",
"",
None,
StackPanel::new().spacing(2.0).children((
ui::label(concat!("Director ", env!("CARGO_PKG_VERSION"))),
ui::note(env!("CARGO_PKG_DESCRIPTION")),
ui::caption(concat!(
env!("CARGO_PKG_AUTHORS"),
" · Requires Windows 11, version 24H2 or newer."
StackPanel::new().spacing(ui::GAP_L).children((
StackPanel::new().spacing(2.0).children((
ui::label(concat!("Director ", env!("CARGO_PKG_VERSION"))),
ui::note(env!("CARGO_PKG_DESCRIPTION")),
ui::caption(concat!(
env!("CARGO_PKG_AUTHORS"),
" · Requires Windows 11, version 24H2 or newer."
)),
)),
self.update_settings(cx, editable),
)),
);
ui::page(
Expand Down
7 changes: 5 additions & 2 deletions src/gui/status_ui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,11 @@ impl DirectorApp {
TextBlock::new()
.text(self.status.clone())
.opacity(0.72)
.text_trimming(TextTrimming::CharacterEllipsis),
ProgressBar::new().is_indeterminate(true),
.text_wrapping(TextWrapping::Wrap),
match self.update_progress() {
Some(done) => ProgressBar::new().maximum(1.0).value(done),
None => ProgressBar::new().is_indeterminate(true),
},
));
}
match &self.notices.notice {
Expand Down
3 changes: 3 additions & 0 deletions src/gui/tv_tip_ui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ pub(crate) enum TipMessage {
KeepCompleted(bool),
DeviceWait(Option<f64>),
InputGuard(Option<f64>),
CheckUpdates(bool),
/// Hide the Scenes page's "make your next scene" tip for good.
HideNextSceneTip,
Saved(Result<Preferences, String>),
Expand Down Expand Up @@ -64,6 +65,7 @@ impl DirectorApp {
message @ (TipMessage::Show(_)
| TipMessage::NotifySceneFailures(_)
| TipMessage::KeepCompleted(_)
| TipMessage::CheckUpdates(_)
| TipMessage::HideNextSceneTip
| TipMessage::DeviceWait(Some(_))
| TipMessage::InputGuard(Some(_)))
Expand All @@ -82,6 +84,7 @@ impl DirectorApp {
next.notify_scene_failures = enabled
}
TipMessage::KeepCompleted(keep) => next.keep_completed_changes = keep,
TipMessage::CheckUpdates(on) => next.check_for_updates = on,
TipMessage::HideNextSceneTip => next.hide_next_scene_tip = true,
TipMessage::DeviceWait(Some(seconds)) => {
next.device_wait_seconds = seconds.round().clamp(1.0, 120.0) as u16
Expand Down
Loading
Loading