Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Bug report
description: Something in Director doesn't work as expected
labels: [bug]
body:
- type: textarea
id: what
attributes:
label: What happened?
description: What you did, what you expected, and what happened instead.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
placeholder: |
1. Open Scenes
2. Apply "TV Gaming"
3. ...
- type: input
id: version
attributes:
label: Director version
description: Run `director --version` or see Options → About.
placeholder: "0.12.0"
validations:
required: true
- type: input
id: windows
attributes:
label: Windows version
description: Settings → System → About, for example "Windows 11 24H2 (26100.2605)".
validations:
required: true
- type: input
id: hardware
attributes:
label: Hardware involved
description: GPU, monitors, audio devices or TV model, if the problem involves them.
- type: textarea
id: logs
attributes:
label: Log lines
description: From Options → Open logs folder. Logs contain no pairing keys, but may contain device names; trim anything you'd rather not share.
render: text
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Blank issues stay enabled: Director's Report on GitHub button opens issues/new with a pre-filled title and body.
blank_issues_enabled: true
contact_links:
- name: Report a security vulnerability
url: https://github.com/Xarishark/Director/security/advisories/new
about: Please report security problems privately.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/crash.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Crash report
description: Director closed unexpectedly
labels: [bug, crash]
body:
- type: markdown
attributes:
value: |
Director saves crash reports in `%LOCALAPPDATA%\Director\Logs\Crashes`. Its **Report on GitHub** button opens a pre-filled issue with the summary and backtrace; this form is for reports you file by hand.
- type: textarea
id: doing
attributes:
label: What were you doing?
description: The page you were on and the last thing you clicked or ran.
validations:
required: true
- type: textarea
id: report
attributes:
label: Crash report
description: Paste the contents of the newest crash-….txt file, or attach it.
render: text
- type: input
id: version
attributes:
label: Director version
placeholder: "0.12.0"
validations:
required: true
- type: input
id: windows
attributes:
label: Windows version
validations:
required: true
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## What and why

<!-- What this changes and why. Link the issue it fixes, if any. -->

## Checks

- [ ] `cargo fmt --all -- --check`
- [ ] `cargo clippy --locked --all-targets -- -D warnings`
- [ ] `cargo test --locked -- --test-threads=1`
- [ ] Docs and README updated where behaviour changed
- [ ] `THIRD_PARTY_LICENSES.md` regenerated if dependencies changed

## Tested by hand

<!-- What you checked in the app or on real hardware (displays, audio, TV model), or "not needed". -->
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Changelog

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

## 0.12.0 (2026-11-07)

- Scenes can **Return** to another saved scene when you end them or run them again.
- The Active dot sits before the scene name, and card names use the space the buttons leave.

## 0.11.0 (2026-11-07)

- **Scenes overhaul**: a step-flow editor with Before, When leaving and Close app actions; the active scene and **End**; a first-run "everyday setup" scene; the TV can turn off when you leave a scene.
- **Sound**: live output, volume and mute controls on Now and in `director audio`; scenes hold their own Sound step.
- **CLI names** for every item (`director scene apply tv-gaming`), `director list`, and a `>_` button on cards that copies the command.
- **TV input protection** keeps an LG TV on the scene's input while a streaming box or console tries to take it; `director tv toggle` turns a TV on or off.
- A UI pass with a shared design system, a reworked Now page and a Windows-style display editor; preset cards preview their screens.
- Local crash reports you can file as GitHub issues; Windows 11 24H2 is now the minimum; a new app icon.

## 0.10.0 (2026-11-05)

- `Director-x64-setup.exe` installs the Windows App Runtime when it's missing, then Director for all users.
- Every version increase merged into `main` publishes a release with the setup.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing to Director

Thanks for helping. Bug reports, TV compatibility reports and pull requests are all welcome.

## Reporting a problem

- **Crashes**: Director saves a crash report and offers **Report on GitHub** the next time it starts. That opens a pre-filled issue; attach the crash file from `%LOCALAPPDATA%\Director\Logs\Crashes` if you can.
- **Bugs**: open an issue with your Windows version, your Director version (`director --version` or **Options → About**), the steps that went wrong, and recent log lines from **Options → Open logs folder** if they help. Logs never contain pairing keys, but they can contain device names; trim anything you'd rather not share.
- **TV compatibility**: follow [Test a Samsung or TCL TV](docs/TV_TESTING.md) and attach the exported report.
- **Security issues**: please don't open a public issue; see [SECURITY.md](SECURITY.md).

## Building

You need Windows 11 24H2 or newer, Rust 1.95 or newer with the MSVC toolchain, and the Visual Studio C++ Build Tools. Then:

```powershell
cargo run
```

[docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) covers the toolchain, the tests and preview fixtures, packaging and CI.

## Pull requests

1. Branch from `main`: `feat/<topic>` for features, `fix/<topic>` for fixes, `docs/`, `chore/` or `refactor/` otherwise.
2. Keep each pull request to one change, and each commit to one step. Commit messages follow [Conventional Commits](https://www.conventionalcommits.org) like the existing history, for example `fix(scenes): keep the Return target after a rename`.
3. Run the same checks as CI before pushing:

```powershell
cargo fmt --all -- --check
cargo clippy --locked --all-targets -- -D warnings
cargo test --locked -- --test-threads=1
```

4. Update the docs in `docs/` and the README when behaviour changes, and explain design choices in the pull request description.
5. Open the pull request against `main`. The **Windows x64 build** check must pass.

Some things can't be tested in CI: applying layouts, switching audio, and talking to a real TV. Say in the pull request what you checked by hand and on which hardware. Don't change devices on someone else's machine without asking.

### Conventions

- Use the shared UI vocabulary in `src/ui.rs` (type ramp, spacing, theme brushes, page, section and card builders) instead of raw sizes and colours.
- Don't put tooltips inside a `ContentDialog`: the pinned Reactor closes the window. See [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md#winui-rules-worth-knowing).
- Device and settings changes take `windows_audio::OperationLock`, run off the UI thread, verify by reading back, and restore what they changed on failure.
- Talk to Windows and TVs directly rather than through helper programs. New dependencies need a reason, and their licenses must be accepted in `packaging/about.toml`; regenerate `THIRD_PARTY_LICENSES.md` when they change.

By contributing, you agree that your contribution is licensed under the [MIT License](LICENSE).
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ rust-version = "1.95"
publish = false
description = "Switch displays, audio, and TVs with reusable scenes on Windows."
authors = ["Xarishark • Zacharias Xenakis"]
license = "MIT"
repository = "https://github.com/Xarishark/Director"

[dependencies]
windows-reactor = "=0.100.0"
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Zacharias Xenakis

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 0 additions & 5 deletions LICENSE.md

This file was deleted.

Loading
Loading