mirror of
https://github.com/NohamR/xovi-qmd-extensions.git
synced 2026-07-11 22:42:39 +00:00
5c8ee270fc
Extends the quick settings timer/chrono module with recurring alarms, alarm persistence, notification handling, and light blinking on alerts. Updates the system clock settings UI, README, hash config, and screenshots to match the new alarm flow.
154 lines
9.1 KiB
Markdown
154 lines
9.1 KiB
Markdown
# Xovi Extensions
|
|
|
|
## Installation
|
|
|
|
Installation via the [Vellum package manager](https://github.com/vellum-dev/vellum) is recommended. Dependencies are handled automatically.
|
|
|
|
### Manual
|
|
|
|
<details>
|
|
All extensions require qt-resource-rebuilder, some will require other xovi extensions. See each extension for details.
|
|
|
|
Instructions to install xovi can be found [here](https://github.com/asivery/rmpp-xovi-extensions).
|
|
|
|
Download the extensions from the folder matching your reMarkable software version.
|
|
|
|
Copy the `.qmd` files to `/home/root/xovi/exthome/qt-resource-rebuilder/` and restart xovi.
|
|
</details>
|
|
|
|
## Notes
|
|
Some of the QMD files in this repo are my own and some are modifications I've made to extensions created by others in the community. Modifications will link to the original author. Extensions have been tested only for the latest reMarkable OS version, though they may work on newer versions.
|
|
|
|
## Compatibility
|
|
|
|
| Extension | `3.22.0.64` | `3.23.0.64` | `3.24.0.149` | `3.25.1.1` | `3.26.0.68` | `3.27.1.0` | `3.27.3.0` | Comment |
|
|
| ----------------------- | ----------- | ----------- | ------------ | ---------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------- |
|
|
| `batteryPercentage` | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | |
|
|
| `clock` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | |
|
|
| `convertToText_remover` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | |
|
|
| `hideDocumentClose` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | Use [hide-document-close](https://github.com/ingatellent) by ingatellent instead |
|
|
| `quickSettingsClock` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | |
|
|
| `quickSettingsTimer` | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | |
|
|
| `uncompressDock` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | |
|
|
| `favoriteButton` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | Implemented by reMarkable in later versions |
|
|
| `forceSync` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | WIP |
|
|
| `tagButton` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | Implemented by reMarkable in later versions |
|
|
|
|
**Note:** QMDs for version `3.22.4.2` are the same as the ones for `3.22.0.64`.
|
|
|
|
**Note 2:** Make sure to use latest version of qt-resource-rebuilder for best compatibility.
|
|
|
|
## Extensions
|
|
|
|
### `batteryPercentage.qmd`
|
|
[](https://vellum.delivery/#/package/battery-percentage/)
|
|
- Shows the battery percentage next to the battery icon in the main view header.
|
|
|
|
<img src="images/batteryPercentage.png" width="400">
|
|
|
|
**Available for:** `3.24.0.149`, `3.25.1.1`, `3.26.0.68`, `3.27.1.0`, `3.27.3.0`
|
|
|
|
---
|
|
|
|
### `clock.qmd`
|
|
[](https://vellum.delivery/#/package/sidebar-clock/)
|
|
- Adds a live clock to the library sidebar; tap the entry to toggle seconds display.
|
|
|
|
<img src="images/clock_1.png" width="300"><img src="images/clock_2.png" width="300">
|
|
|
|
**Note:** You have to set the right timezone on the tablet (you can use [reManager](https://github.com/rmitchellscott/reManager) to set it)
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`, `3.24.0.149`, `3.25.1.1`, `3.26.0.68`, `3.27.1.0`, `3.27.3.0`
|
|
|
|
---
|
|
|
|
### `convertToText_remover.qmd`
|
|
[](https://vellum.delivery/#/package/convert-to-text-remover/)
|
|
- Removes the `Convert to text` option from selection menus and the toolbar.
|
|
|
|
<img src="images/convertToText_remover.png" width="400">
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`, `3.24.0.149`, `3.25.1.1`, `3.26.0.68`, `3.27.1.0`, `3.27.3.0`
|
|
|
|
---
|
|
|
|
### `hideDocumentClose.qmd`
|
|
- Hides the close button in the document toolbar to prevent accidental exits.
|
|
Use [hide-document-close](https://github.com/ingatellent) by ingatellent instead.
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`
|
|
|
|
---
|
|
|
|
### `quickSettingsClock.qmd`
|
|
- Injects a tappable clock into the Quick Settings header; tap to toggle between minute and second precision.
|
|
Use [quicksettings-clock-serif](https://github.com/rmitchellscott) by rmitchellscott instead.
|
|
|
|
<img src="images/quickSettingsClock.png" width="400">
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`, `3.24.0.149`, `3.25.1.1`, `3.26.0.68`, `3.27.1.0`, `3.27.3.0`
|
|
|
|
---
|
|
|
|
### `quickSettingsTimer.qmd`
|
|
<!-- [](https://vellum.delivery/#/package/quicksettings-timer/) -->
|
|
- Adds a countdown timer, stopwatch, and alarm system to the Quick Settings panel, under the light slider.
|
|
- Timer: presets: 1min, 5min, 10min, 30min, 1h; add/set mode toggle (<img src="images/plus.svg" width="20" height="20"> increments, <img src="images/plus_circle.svg" width="20" height="20"> replaces), start/stop/reset controls.
|
|
- Chrono: start/stop with lap-style elapsed time display.
|
|
- Alarm: configure recurring alarms in the system clock settings menu with a time picker (hour/minute spinners), quick-off buttons (00/15/30/45, +15/+30/+45), and a "Now" button. Each alarm has an enable/disable toggle and a delete button.
|
|
- Flash light toggle in the alarm settings page: when enabled, the reading light blinks 3 times when the timer finishes or an alarm triggers.
|
|
- Persistence: alarms and the flash light toggle are saved to `file:///home/root/alarms.json` on changes and auto-loaded on startup.
|
|
- Notification bar: shows "Time's up! (duration)" when the timer finishes, or "Alarm at HH:MM" when an alarm triggers. Timer offers Restart/+1min/+5min buttons; alarm offers a Dismiss button.
|
|
- Quick access: an "Add alarms" button in Quick Settings opens the system clock alarm management page directly.
|
|
- Setting page: Go to `Settings > Help > System Time` to manage alarms and the flash light toggle.
|
|
|
|
<img src="images/quickSettingsTimer_1.png" width="200"><img src="images/quickSettingsTimer_2.png" width="200"><img src="images/quickSettingsTimer_3.png" width="200">
|
|
<img src="images/quickSettingsTimer_4.png" width="600">
|
|
<img src="images/quickSettingsTimer_5.png" width="600">
|
|
|
|
**Available for:** `3.24.0.149`, `3.25.1.1`, `3.26.0.68`, `3.27.1.0`, `3.27.3.0`
|
|
|
|
---
|
|
|
|
### `uncompressDock.qmd`
|
|
[](https://vellum.delivery/#/package/uncompress-dock/)
|
|
- Replaces the widget-based create menu with dedicated buttons for notebook, folder, and quick sheet creation.
|
|
- **Rewritten** for the new `HomeScreen.CreateMenu` — the old `Navigator.CreateMenu` is no longer used in 3.27.
|
|
- Note: Notebook and Folder use Navigator methods; Quicksheet uses `LibraryController` (experimental).
|
|
|
|
<img src="images/uncompressDock.png" width="400">
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`, `3.24.0.149`, `3.25.1.1`, `3.26.0.68`, `3.27.1.0`, `3.27.3.0`
|
|
|
|
---
|
|
|
|
### `favoriteButton.qmd`
|
|
[](https://vellum.delivery/#/package/favorite-button/)
|
|
- Restores a `Favorite` action in the document list header for faster pinning.
|
|
|
|
<img src="images/favoriteButton.png" width="400">
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`\*
|
|
*\*No longer needed — implemented by reMarkable in later versions.*
|
|
|
|
---
|
|
|
|
### `forceSync.qmd`
|
|
[](https://vellum.delivery/#/package/force-sync/)
|
|
- Adds a cloud button in Quick Settings that forces a library sync when tapped (WIP — further testing needed).
|
|
|
|
<img src="images/forceSync.png" width="400">
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`
|
|
|
|
---
|
|
|
|
### `tagButton.qmd`
|
|
[](https://vellum.delivery/#/package/tag-button/)
|
|
- Puts a `Tag` action next to other list controls to open the tag editor directly.
|
|
|
|
<img src="images/tagButton.png" width="400">
|
|
|
|
**Available for:** `3.22.0.64`, `3.23.0.64`\*
|
|
*\*No longer needed — implemented by reMarkable in later versions.*
|