beffroi-tools/README.md

131 lines
10 KiB
Markdown

<h1 align="center">beffroi-tools</h1>
<p align="center">Local tools for presentations, show timing, screen layouts and media workflows.</p>
<p align="center">
<img src="https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/version.svg" alt="Current version">
<img src="https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/test.svg" alt="Test status">
<img src="https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/coverage.svg" alt="Line coverage">
</p>
<p align="center">
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/releases.md">Portable releases</a> ·
<a href="#quick-start">Quick start</a> ·
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/README.md">Documentation</a> ·
<a href="https://books.dandaedre.com/manuals/">Full manuals</a> ·
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/changelogs.md">What's new</a> ·
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/README.md">Development</a>
</p>
## Choose your tool
<table>
<tr>
<td width="50%" valign="top">
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/README.md"><img src="crates/pptx-reporter/assets/app-icon.png" width="72" height="72" alt="PPTX Reporter icon"></a>
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/README.md">PPTX Reporter</a></h3>
<p>Inspect presentation videos, read playback timings, and export reports or Ontime rundowns.</p>
<p><strong>Desktop app · CLI</strong></p>
<p><a href="https://books.dandaedre.com/manuals/pptx-reporter/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/visual-guide.md">Visual walkthrough</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/README.md">Guide</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/report-formats.md">Report formats</a></p>
</td>
<td width="50%" valign="top">
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/README.md"><img src="crates/rundown-converter/assets/app-icon.png" width="72" height="72" alt="Rundown Converter icon"></a>
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/README.md">Rundown Converter</a></h3>
<p>Turn spreadsheet rundowns into Ontime schedules, with timing checks before export.</p>
<p><strong>Desktop app · CLI</strong></p>
<p><a href="https://books.dandaedre.com/manuals/rundown-converter/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/README.md">Guide</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/corpus.md">Sample findings</a></p>
</td>
</tr>
<tr>
<td valign="top">
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/canvas-pilot/README.md"><img src="crates/canvas-pilot/assets/app-icon.png" width="72" height="72" alt="Canvas Pilot icon"></a>
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/canvas-pilot/README.md">Canvas Pilot</a></h3>
<p>Arrange screen layers, exchange geometry, and review transfers to an Eikos 4K device.</p>
<p><strong>Desktop app</strong></p>
<p><a href="https://books.dandaedre.com/manuals/canvas-pilot/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/canvas-pilot/README.md">Guide</a> · <a href="#canvas-pilot-templates">Templates</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/interfaces/canvas-pilot-exchange.md">Geometry formats</a></p>
</td>
<td valign="top">
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/ascii-names/README.md"><img src="crates/ascii-names/assets/app-icon.png" width="72" height="72" alt="ASCII Names icon"></a>
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/ascii-names/README.md">ASCII Names</a></h3>
<p>Clean up filenames to ASCII with paced renames, collision protection, and unchanged file contents.</p>
<p><strong>Desktop app · CLI</strong></p>
<p><a href="https://books.dandaedre.com/manuals/ascii-names/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/ascii-names/README.md">Guide</a></p>
</td>
</tr>
<tr>
<td valign="top">
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/exporter/README.md"><img src="tools/assets/exporter/app-icon.png" width="72" height="72" alt="Document Exporter icon"></a>
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/exporter/README.md">Document Exporter</a></h3>
<p>Export PPTX to PDF or slide images, render PDF pages, and compress PDFs to a target size.</p>
<p><strong>Python CLI</strong></p>
<p><a href="https://books.dandaedre.com/manuals/exporter/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/exporter/README.md">Guide and dependencies</a></p>
</td>
<td valign="top">
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/companion-modules/media-player-classic/README.md"><img src="companion-modules/media-player-classic/companion/assets/app-icon.png" width="72" height="72" alt="MPC-HC Companion icon"></a>
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/companion-modules/media-player-classic/README.md">MPC-HC Companion</a></h3>
<p>Control Media Player Classic Home Cinema from Companion with playback actions and player feedback.</p>
<p><strong>Companion 5.1 module</strong></p>
<p><a href="https://books.dandaedre.com/manuals/media-player-classic/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/companion-modules/media-player-classic/README.md">Setup and development</a></p>
</td>
</tr>
</table>
## Quick start
**Start with a portable app:** see [release bundles and platform instructions](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/releases.md).
For PPTX Reporter, extract the ZIP and open `pptx-reporter-gui.exe` on Windows
or run `./pptx-reporter-gui` on macOS 13+. Choose the macOS archive for
[Apple Silicon or Intel](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/releases.md#macos). Keep the bundled FFprobe beside the app.
Drop a presentation or video folder into the reporter, choose report formats,
and generate. The [illustrated guide](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/visual-guide.md) walks through each step;
a [Windows quick start](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/windows-quickstart.txt) is also available.
<details>
<summary><strong>Run from source</strong> — Rust apps and Python exporter</summary>
Run these commands from the repository root:
```sh
# PPTX Reporter: desktop, full report, or Ontime timings
cargo run --locked --bin pptx-reporter-gui
cargo run --locked --bin pptx-reporter -- presentation.pptx --report all
cargo run --locked --bin pptx-reporter -- ./show --timings-only --report ontime
# Other desktop apps
cargo run --locked -p rundown-converter --bin rundown-converter-gui
cargo run --locked -p canvas-pilot
cargo run --locked -p ascii-names
# Document exports
python3 tools/exporter.py presentation.pptx --output pdf,images
```
The reporter needs FFprobe; PDF generation is built in. The exporter needs
DeckCraft for PPTX or PdfCraft for PDF input. CLI tools support `--help`.
See [development setup](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/README.md) for prerequisites and checks.
</details>
## Canvas Pilot templates
[**Download all templates as ZIP**](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/raw/branch/main/docs/templates/canvas-pilot/canvas-pilot-all-templates.zip) · [Browse individual starter files →](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/templates/canvas-pilot/README.md)
Matching Full HD and UHD 4K layouts are available in SVG, draw.io, geometry JSON,
CSV, DXF/DWG, HTML, PPTX, Figma FIG, FigCraft and Illustrator AI. The catalog contains every
base file, import guidance and format dependencies.
**Prefer SVG for Illustrator exchange.** AI is an optional compatibility target
and requires a separately installed **VectorCraft CLI** for import and export.
[AI requirements and setup](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/canvas-pilot/guide/files.md#illustrator-ai-optional-converter-required).
## Explore further
| Resource | Links |
| --- | --- |
| Updates | [Per-tool changelogs](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/changelogs.md) |
| Build and contribute | [Development](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/README.md) · [CI and coverage](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/ci.md) · [Cross builds and releases](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/releases.md) |
| Desktop integration | [App icons and launchers](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/releases.md#application-artwork) |
| Midra internals | [Project format](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/interfaces/canvas-pilot.md) · [Device checks](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/canvas-pilot/device-check.md) · [Plan](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/canvas-pilot/plan.md) |
| What's next | [Ideas](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/Ideas.md) · [Program task list](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/planning/program-task-list.md) |