rM Hacks Documentation 0.0.10 - mb1986/rm-hacks GitHub Wiki

rM Hacks Documentation

rM Hacks Documentation

The rM Hacks Documentation can be found at

https://github.com/mb1986/rm-hacks/wiki


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 also Releases and CHANGELOG.md.

  • Screenshots with long press on power button or 5-finger long press (new in 0.0.10)
  • ScreenShare everywhere, including outside of documents (new in 0.0.10)
  • Disable the black border on pdf and epub when zoomed out (new in 0.0.10)
  • Toggle for rM Hacks general screen orientation vs. native document orientation (new in 0.0.10)
  • Fast screen drawing and refresh (new in 0.0.10)
  • Gestures to reset viewport and show/hide toolbar (new in 0.0.10)
  • Dropdown menu to choose screen orientation (new in 0.0.10)
  • Zoom and selection tool shortcuts with Type Folio (new in 0.0.10)
  • Document-level toggle to enable and disable rotation snapping (new in 0.0.10)
  • Document-level toggle to enable and disable screen refresh (new in 0.0.10)
  • Button to open files in Layers menu (new in 0.0.10)
  • Split Document, view two documents side by side (new in 0.0.10)
  • Hide grayed-out features for connect non-subscribers (new in 0.0.10)
  • rm Hacks settings/configuration button in share menu (new in 0.0.10)
  • Hide the Text tool button in the toolbar (new in 0.0.10)
  • Allow for transparent sleepscreen (new in 0.0.10)
  • Archived indicator in the compressed list (new in 0.0.10)

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
  • 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
  • Table of Contents button
  • Brush / Tool icon (when toolbar is closed)
    • Add colors abbreviations to the color icon
    • Add a setting to hide the document toggle for toolbar
  • Jump straight to the tags view
  • Document-level toggle buttons in the export/share popout
  • Quicktools bar to store shortcut to tools
  • Quicktools button in toolbar
  • Add a setting to hide the toolbar header
  • Hide text tool (new in 0.0.10)

Navigation

  • Bookmarks navigation grid
  • Compressed List option for document lists
  • Tags are alphabetized on Menu ⇒ Tags display
  • Jump straight to the tags view
  • Persist the tags filter
  • 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
    • Dropdown menu to choose orientation (new in 0.0.10)
    • Toggle for rM Hacks general screen orientation vs. native document orientation (new in 0.0.10)
  • Fast screen drawing and refresh (new in 0.0.10)
  • Hacks configuration button in share menu (new in 0.0.10)
  • Button to open files in Layers menu (new in 0.0.10)

Writing

Gestures (writing)

  • Swipe one finger down in the body of the page to open/close toolbar.
    • Alternative gesture: swipe from the edge to show the toolbar and swipe towards the edge to hide it (new in 0.0.10)
  • Swipe one finger up in the body of the page to open/close QuickTools bar.
  • Swipe one finger down in the top corner closest to the toolbar to switch between the last two tools.
  • Swipe one finger up in the top corner closest to the toolbar to switch between the writing tool and eraser.
  • Swipe one finger down in the top corner opposite the toolbar to swap the last two pen thicknesses (strokes).
  • Swipe one finger up in the top corner opposite the toolbar to swap the last two colors.
  • Five-finger tap triggers screen refresh
  • Hide new page button when swiping to new page
    • Remove last empty page when swiping to the previous page
  • Add page on edge double tap
  • Remove current empty page on double tap
  • Swipe three fingers down to restore zoom level to 100% (new in 0.0.10)
  • Gestures to reset viewport and show/hide toolbar (new in 0.0.10)

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.
  • Support for transparent (deep) sleep screen (new in 0.0.10)

Bookmarks (writing)

  • Toolbar bookmarks button shows all bookmarks in the currently open document.
  • 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 a grid item in the bookmarks navigation grid 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
  • Screenshots with long press on power button or 5-finger long press (new in 0.0.10)
  • ScreenShare everywhere, including outside of documents (new in 0.0.10)
  • Don't show black border around pdf and epub pages when zoomed out (new in 0.0.10)
  • Document-level toggle to enable and disable rotation snapping (new in 0.0.10)
  • Document-level toggle to enable and disable screen refresh (new in 0.0.10)
  • Zoom and selection tool shortcuts with Type Folio (new in 0.0.10)
  • Button to open files in Layers menu (new in 0.0.10)
  • Split Document, view two documents side by side (new in 0.0.10)
  • Hide grayed-out features for connect non-subscribers (new in 0.0.10)

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
  • Enable/disable Rotation Snap (new in 0.0.10)
  • Enable/disable Screen Refresh (new in 0.0.10)
  • Hacks configuration button (new in 0.0.10)

Features Deep Dive

Toolbar

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

Gestures

Gestures include

  • Open / close toolbar (swipe down)
  • Open / close quicktools (swipe up)
  • 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
  • Remove empty page on double tap
  • Restore viewport level to 100% (new in 0.0.10)
  • Open / close toolbar (swipe from / to edge) (new in 0.0.10)

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
  • Rotation Snap
  • Screen Refresh
  • rM Hacks Settings (navigation button)

See Document-level Settings for more details.

Split Document

The Split Document feature allows you to open and edit two documents at once, or to edit two places in the same document.

See Split Document for more details.

⚠️ **GitHub.com Fallback** ⚠️