Skip to content

rM Hacks Documentation

knox-dawson edited this page Mar 19, 2024 · 29 revisions

rM Hacks Documentation

Installation

See Installation for steps connecting to the tablet via ssh and running the rM Hacks installation command.

Also see SSH Access (https://remarkable.guide/guide/access/ssh.html) for more information about ssh access.

In addition, see the installation instructions in the rM Hacks README.


What's new?

See Releases.


Settings / Configuration

After installing rM Hacks, tap

  • ☰ Menu
  • ⚙ Settings
  • rM Hacks

This displays the rM Hacks Configuration page.

See Settings / Configuration for more details.


Features Overview

Below is a brief listing of features.

See Features Overview for more details.

Toolbar additions

  • Decrease toolbar width (new in 0.0.9)
  • Clock display
  • Battery and WiFi indicators
  • More stroke sizes
  • Current page / Page count display and button
  • Bookmarks button to toggle bookmark and show navigation grid
    • Bookmarks button lower in the toolbar (new in 0.0.9)
    • Bookmark rename input now in the header at the top of the screen (new in 0.0.9)
  • Table of Contents button
  • Brush / Tool icon (when toolbar is closed)
    • Add colors abbreviations to the color icon (new in 0.0.9)
    • Add a setting to hide the document toggle for toolbar (new in 0.0.9)
  • Jump straight to the tags view (new in 0.0.9)
  • Document-level toggle buttons in the export/share popout
  • Quicktools bar to store shortcut to tools (new in 0.0.9)
  • Quicktools button in toolbar (new in 0.0.9)
  • Add a setting to hide the toolbar header (new in 0.0.9)

Navigation

  • Bookmarks navigation grid
  • Compressed List option for document lists
  • Tags are alphabetized on Menu ⇒ Tags display
  • Jump straight to the tags view (new in 0.0.9)
  • Persist the tags filter (new in 0.0.9)
  • Swipe two fingers up from the bottom of the page to cycle between two recent documents.
  • Tap the current page/page count numbers to open fast page scroll.
  • Screen orientation button (new in 0.0.9)

Writing

Gestures (writing)

  • Swipe one finger down in the body of the page to open/close toolbar.
  • Swipe one finger up in the body of the page to open/close QuickTools bar.
  • Swipe one finger down in the top left corner (right-handed)/right corner (left-handed) to switch between the last two tools.
  • Swipe one finger up in the top left corner (right-handed)/right corner (left-handed) to switch between the writing tool and eraser.
  • Swipe one finger down in the top right corner (right-handed)/left corner (left-handed) to swap the last two pen thicknesses (strokes).
  • Swipe one finger up in the top right corner (right-handed)/left corner (left-handed) to swap the last two colors.
  • Five-finger tap triggers screen refresh
  • Hide new page button when swiping to new page (new in 0.0.9)
    • Remove last empty page when swiping to the previous page (new in 0.0.9)
  • Add page on edge double tap (new in 0.0.9)
  • Remove current empty page on double tap (new in 0.0.9)

Sleep mode

  • Enable sleep mode by swiping up from the top of the screen (light or deep sleep selectable in Settings/Security).
  • Display ...zzZ in the top right corner during light sleep mode instead of a big black banner.

Bookmarks (writing)

  • Toolbar bookmarks button showing all bookmarks in the currently open document.
    • Bookmarks button lower in the toolbar (new in 0.0.9)
    • Bookmark rename input now in the header at the top of the screen (new in 0.0.9)
  • Tap in the top corner opposite the toolbar to toggle a bookmark for the current page.
  • Long press in the top corner opposite the toolbar to create a named bookmark or to change the name of an existing one.
  • Long press the bookmarks toolbar button to toggle a bookmark for the current page.
  • Long press the bookmark grid item from the bookmarks menu to rename the bookmark.

Miscellaneous

  • New notebook name defaults to the current date and time (format: yyyy-mm-dd_hhmmss).
  • Add configuration options for various click and press behaviors of the stylus button (new in 0.0.9).

Settings

Settings / Configurations menus under

  • ☰ Menu
  • ⚙ Settings
  • rM Hacks

Document-level toggle buttons (accessible through the Share and Convert menu):

  • Enable/disable WiFi Connection
  • Enable/disable All Gestures
  • Enable/disable rM1 Buttons (rM1 only)
  • Enable/disable Automatic Updates
  • Show/hide clock display
  • Show/hide Battery/WiFi Levels display
  • Enable/disable Straight Lines

Features Deep Dive

Toolbar

In addition to the Toolbar additions section above, also see Toolbar.

Gestures

Gestures include

  • Open / close toolbar
  • Open / close quicktools (new in 0.0.9)
  • Swap the last two tools
  • Swap last tool with eraser
  • Swap the last two pen thicknesses (strokes)
  • Swap the last two colors
  • Open previous document
  • Sleep mode
  • Full screen refresh
  • Add page on edge double tap (new in 0.0.9)
  • Remove empty page on double tap (new in 0.0.9)

See Gestures for more details.

Strokes

rM Hacks adds additional stroke sizes (line thicknesses).

  • five additional sizes for writing tools
  • three additional sizes for the eraser

See Strokes for more details.

Bookmarks

With Bookmarks enabled, any page can be bookmarked and each bookmark can have short text to describe it.

On any page, tapping the bookmarks toolbar icon will show the bookmarks navigation grid where you can jump to any bookmark.

See Bookmarks for more details.

QuickTools

See QuickTools for more details.

Stylus Button Actions

See Stylus Button Actions for more details.

Document-level Settings

This feature allows you to toggle some settings without leaving a document.

  • WiFi Connection
  • All Gestures
  • rM1 Buttons (rM1 only)
  • Automatic Updates
  • Clock
  • Battery/WiFi Levels
  • Straight Lines

See Document-level Settings for more details.

Clone this wiki locally