beffroi-tools/README.md

68 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# beffroi-tools
![current version](https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/version.svg)
![test status](https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/test.svg)
![line coverage](https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/coverage.svg)
Local document and media tools: a Rust PPTX video reporter with a drag-and-drop
app, a spreadsheet rundown converter for Ontime, an ASCII filename cleaner,
and Python document exports.
## Quick start
On Windows, extract the portable ZIP and open `pptx-reporter-gui.exe`.
Drop PPTX files or a video folder into the window, select report formats, and generate.
Keep the bundled `ffprobe.exe` beside the app.
On macOS 13+, extract the portable ZIP for Apple Silicon (`aarch64`) or Intel
(`x86_64`) and run `./pptx-reporter-gui`. FFprobe is included; keep it beside the app.
See [macOS release details](docs/releases.md#macos).
To run from source:
```sh
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
cargo run --locked -p rundown-converter --bin rundown-converter-gui
cargo run --locked -p ascii-names
python3 tools/exporter.py presentation.pptx --output pdf,images
```
The reporter needs FFprobe (included in portable bundles); PDF generation is
built in. The exporter needs DeckCraft for PPTX or PdfCraft for PDF input.
Run source commands from the repository root; CLI tools support `--help`.
## Midra Layout templates
These starter files contain two named 16:9 layers on an exact pixel canvas.
They can be opened in draw.io or imported into Midra Layout.
| Output canvas | SVG | draw.io |
| --- | --- | --- |
| Full HD — 1920 × 1080 | [Download SVG](docs/templates/midra-layout/midra-layout-1080p-2-layers.svg) | [Download draw.io](docs/templates/midra-layout/midra-layout-1080p-2-layers.drawio) |
| UHD 4K — 3840 × 2160 | [Download SVG](docs/templates/midra-layout/midra-layout-4k-2-layers.svg) | [Download draw.io](docs/templates/midra-layout/midra-layout-4k-2-layers.drawio) |
## PPTX reporter visual guide
**[Follow the illustrated PPTX reporter guide →](docs/user-guide.md)**
Screenshots walk you through choosing a presentation, selecting formats,
opening reports, and reading video timings.
## More documentation
- [Changelogs](docs/changelogs.md) — short per-tool change notes
- [Reporter](docs/rust-reporter.md) · [Windows quick start](docs/windows-quickstart.txt)
- [Report formats and timing semantics](docs/pptx-videos.md)
- [ASCII filename cleaner](docs/ascii-names.md)
- [Document exports](docs/exporter.md)
- [Rundown converter](docs/rundown-converter.md) · [Sample findings](docs/rundown-corpus.md)
- [Midra layout helper](docs/midra-layout.md) · [Plan and visual proposals](docs/midra-layout-plan.md) · [File formats](docs/interfaces/midra-layout.md)
- [Development](docs/development.md) · [CI and coverage](docs/ci.md)
- [Cross builds and portable releases](docs/releases.md) · [App icons and desktop launchers](docs/releases.md#application-artwork)
- [MPC-HC Companion module development](companion-modules/media-player-classic/README.md)
- [Future ideas](Ideas.md)
- [Future program task list](docs/program-task-list.md)