170 lines
9.6 KiB
Markdown
170 lines
9.6 KiB
Markdown
<p align="center">
|
|
<img src="crates/deckstride/assets/app-icon.png" width="96" height="96" alt="Deckstride icon">
|
|
</p>
|
|
<h1 align="center">Deckstride</h1>
|
|
<p align="center"><strong>A fast, portable presenter for PDFs and picture folders.</strong></p>
|
|
<p align="center">Fullscreen slides for the room. Notes, previews and controls for you.</p>
|
|
|
|
<p align="center">
|
|
<a href="docs/changelog.md"><img src="https://assets.dandaedre.com/coverage/idle-org/deckstride/main/version.svg" alt="Version"></a>
|
|
<a href="docs/development/ci.md"><img src="https://assets.dandaedre.com/coverage/idle-org/deckstride/main/test.svg" alt="Tests"></a>
|
|
<a href="docs/development/ci.md"><img src="https://assets.dandaedre.com/coverage/idle-org/deckstride/main/coverage.svg" alt="Coverage"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://proxy.dandaedre.com/gitea/idle-org/deckstride/releases"><strong>Download Deckstride</strong></a> ·
|
|
<a href="docs/user-guide.md">User guide</a> ·
|
|
<a href="https://proxy.dandaedre.com/gitea/idle-org/deckstride/issues">Report an issue</a>
|
|
</p>
|
|
|
|
Deckstride gives each connected screen a job: **Presenter**, **Slides**, or
|
|
**Unused**. Keep the current slide, next slide, notes and timers in front of you
|
|
while one or more other screens show only the presentation. You can also mirror the
|
|
Presenter view, rehearse on one monitor, or change the arrangement during a session.
|
|
|
|
<p align="center">
|
|
<img src="docs/images/presenter-overview.png" alt="Presenter view showing the current slide, next slide, fitted notes, timer and navigation" width="100%">
|
|
</p>
|
|
|
|
The application is built around a simple requirement: advancing a slide should feel
|
|
immediate. Prepared slides are buffered in RAM, reusable processed images make a
|
|
second opening faster, and large decks use a rolling buffer instead of exhausting
|
|
memory. Rendering, notes and file work run outside the presentation controls so a
|
|
slow document operation does not have to freeze navigation.
|
|
|
|
## What it does well
|
|
|
|
| Feature | What it means while presenting |
|
|
| --- | --- |
|
|
| **Real multi-screen control** | Assign Presenter or Slides to every connected monitor. Repeat either role across several screens. Display changes use a confirmation timer and revert if the new arrangement is wrong. |
|
|
| **Layouts for each Presenter screen** | Resize or hide the current slide, next slide, previous slide, notes, timers and progress bar. Save a layout for one project or as a default, with separate preferences for different screens. |
|
|
| **Fast, visible preparation** | The Presenter reports what it is preparing, RAM use and an ETA when available. Prepared nearby slides are served from RAM; a bounded rolling buffer reloads distant slides only when needed. |
|
|
| **Useful live tools** | Point, draw arrows and highlight without modifying the PDF or rerendering slide images. Tool size follows the visible slide, including high-resolution output. |
|
|
| **Shared zoom** | Opt in to zoom, pan or fit a page to width from Presenter or Slides. Both views stay on the same part of the page. |
|
|
| **Safe slide browsing** | Browse resizable thumbnails without changing the live slide. Double-click to preview, or enable **Change on click** when direct switching is useful. |
|
|
| **Notes that belong to the presentation** | Read notes from a sidecar or the PDF, import TXT/Markdown, and double-click the notes pane to edit the current slide. Notes automatically fit the available space. |
|
|
| **Presentation-aware desktop behavior** | Deckstride asks supported operating systems to keep the display awake and reports whether protection is active. Closing Presenter also closes its Slides windows. |
|
|
| **Portable by design** | The release binaries include the PDF renderer and application dependencies. Keep the extracted folder anywhere convenient; no Rust or separate PDF software is required. |
|
|
| **Themes and languages** | Choose from 20 built-in palettes and seven interface languages, or import bounded offline language/theme packs. |
|
|
|
|
On Windows, multi-screen output, per-screen layouts, zoom, tools, and unplugging then
|
|
reconnecting displays have been tested in extended use. Linux and macOS use the same
|
|
presentation model, but desktop and window-manager behavior still deserves testing
|
|
on the machines that will run the show.
|
|
|
|
## Download and run
|
|
|
|
Open the [release page](https://proxy.dandaedre.com/gitea/idle-org/deckstride/releases)
|
|
and download the archive for your computer.
|
|
|
|
| Platform | Recommended download | Start after extracting |
|
|
| --- | --- | --- |
|
|
| Windows x86_64 | `deckstride-portable-x86_64-pc-windows-gnu-v….zip` | `deckstride.exe` |
|
|
| Linux x86_64 | `deckstride-portable-x86_64-unknown-linux-gnu-v….tgz` | `./deckstride` |
|
|
| Linux ARM64 | `deckstride-portable-aarch64-unknown-linux-musl-v….tgz` | `./deckstride` |
|
|
| Apple Silicon macOS 13+ | `deckstride-portable-aarch64-apple-darwin-v….tgz` | Follow the release-page macOS instructions |
|
|
| Intel macOS 13+ | `deckstride-portable-x86_64-apple-darwin-v….tgz` | Follow the release-page macOS instructions |
|
|
|
|
Windows and macOS builds are currently unsigned. Releases are ready for normal use;
|
|
test the actual computer, adapters and display arrangement before a live event.
|
|
macOS artifacts are cross-built on Linux and have not yet had native Mac runtime
|
|
testing. [Installation and update details →](docs/user-guide.md#install-and-update)
|
|
|
|
If you already have [cargo-binstall](https://github.com/cargo-bins/cargo-binstall)
|
|
installed, install the prebuilt release directly:
|
|
|
|
```sh
|
|
cargo binstall deckstride --git https://proxy.dandaedre.com/gitea/idle-org/deckstride --version 0.1.96 --strategies crate-meta-data
|
|
```
|
|
|
|
Replace `0.1.96` with another published Deckstride version when needed. Then run
|
|
`deckstride`.
|
|
|
|
## Set up a show
|
|
|
|
1. **Open a PDF or picture folder.** Use Menu, drag and drop, or open an associated
|
|
PDF on Windows. Pictures follow natural filename order.
|
|
2. **Choose where each view goes.** Open **Displays**, select Presenter, Slides or
|
|
Unused for each monitor, then apply the change. Keep the proposal or let it revert.
|
|
3. **Arrange your Presenter view.** Open **Layout** to size and position slides,
|
|
notes, clocks and progress. Save it for this presentation or for all projects.
|
|
4. **Present.** Use Left/Right, Page Up/Page Down or Space. Type a slide number and
|
|
press Enter to jump directly to it. Press B to blank or restore Slides.
|
|
|
|
Deckstride shows Slides by default after a document opens. Entering or leaving
|
|
fullscreen and changing screen assignments preserve that choice. Header and footer
|
|
controls can auto-hide; move the pointer near their edge or right-click to recover
|
|
them.
|
|
|
|
<table>
|
|
<tr>
|
|
<td width="50%"><img src="docs/images/display-routing.png" alt="Displays panel assigning Presenter and Slides across two monitors"></td>
|
|
<td width="50%"><img src="docs/images/all-slides.png" alt="All slides browser with three resizable slide thumbnails"></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><strong>Route and mirror screens</strong></td>
|
|
<td align="center"><strong>Browse without disturbing the live slide</strong></td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Zoom and point while presenting
|
|
|
|
Enable page zoom from Menu when a document needs it. Scroll to zoom, drag to pan,
|
|
and double-click to fit the page width or reset. The crop is shared with Slides and
|
|
uses the already buffered image.
|
|
|
|
Open **Tools** for a pointer, arrows and a highlighter. Marks remain vector overlays
|
|
on the current slide and can be undone or cleared instantly. Their apparent size is
|
|
scaled between the smaller Presenter preview, 1080p output and 4K output.
|
|
|
|
<p align="center">
|
|
<img src="docs/images/presenter-tools.png" alt="Presenter view with the pointer toolbox open and a pointer visible on the current slide" width="100%">
|
|
</p>
|
|
|
|
## Slides, notes and shortcuts
|
|
|
|
PDFs work directly. A picture folder becomes a deck using natural filename order;
|
|
for example, `slide_2.png` comes before `slide_10.png`. Notes may come from embedded
|
|
PDF annotations, a `.notes.toml` sidecar, per-slide text files, or imported TXT and
|
|
Markdown. Source slides and imported note files are not overwritten.
|
|
|
|
Useful controls:
|
|
|
|
- **Right / Space** — next slide
|
|
- **Left / Shift+Space** — previous slide
|
|
- **Number, then Enter** — jump to a slide
|
|
- **Hold S for one second** — swap Presenter and Slides screens, then Keep or Revert
|
|
- **B** — blank or restore Slides
|
|
- **P / A / H** — pointer, arrow or highlighter
|
|
- **Escape / Ctrl+Q** — request quit confirmation (Escape first reverts an active display trial)
|
|
|
|
[Notes, layouts and controls →](docs/user-guide.md) ·
|
|
[Notes file formats →](docs/interfaces/presentation-notes.md) ·
|
|
[Preparation, cache and RAM behavior →](docs/user-guide.md#preparation-processed-slides-and-ram)
|
|
|
|
## Add languages and themes
|
|
|
|
Open **Preferences → General → Appearance** and choose **Import language pack…**
|
|
or **Import theme pack…**. Imported choices appear in the existing Language and
|
|
Theme selectors without restarting Deckstride. Packs stay offline and contain data
|
|
only.
|
|
|
|
Editable examples and ready-to-import ZIPs:
|
|
|
|
- [Language pack example](docs/packs/deckstride-language-pack.zip)
|
|
- [Theme pack example](docs/packs/deckstride-theme-pack.zip)
|
|
- [Pack format and limits](docs/packs/README.md)
|
|
|
|
## Open source
|
|
|
|
Deckstride is independent open-source software under the [MIT license](LICENSE).
|
|
Development includes LLM-generated or LLM-assisted work with human review. The
|
|
project is used in professional settings, while physical acceptance work remains
|
|
documented rather than hidden.
|
|
|
|
---
|
|
|
|
[Development and source builds](docs/development/README.md) ·
|
|
[Changelog](docs/changelog.md) · [MIT license](LICENSE) ·
|
|
[More beffroi tools](https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools)
|