rM Hacks Documentation 0.0.8

rM Hacks Documentation

1. Installation
2. Settings / Configuration
3. Features Overview
4. Features Deep Dive
   • Gestures
   • Strokes
   • Bookmarks
   • Pen Button Actions
   • Document-level Settings

Installation

Note

The instructions below walk through steps to connect to the tablet via ssh (to run the installation command).

See also SSH Access (https://remarkable.guide/guide/access/ssh.html) for more information.

Also see installation instructions in the rM Hacks README.

To install rm-hacks, you have to connect to your reMarkable tablet from a computer. You can use either USB or Wi-Fi to connect, but connect now before proceeding. To connect to Wi-Fi, make sure that you aren't in Flight mode in the Settings, and make sure the Wi-Fi settings shows Connected

Get IP address and rM password

• From the main settings screen, press the Help > About button
• Then press Copyrights and licenses
• Then scroll all the way down to find your password and IP address:
  • If you are connected to both USB and Wi-Fi, you may see 2 IP addresses listed. If so, you can use either one.

Connecting to reMarkable from a Windows computer

• From the Windows menu, type CMD to open a Command Prompt
• Type ssh root@your_ip_address and hit Enter. When prompted, carefully type your rM password, which will not appear as you type it, and then press Enter. If you are successful, your screen should look like this:
• Type in the following and hit enter:

sh -c "$(wget https://raw.githubusercontent.com/mb1986/rm-hacks/main/install.sh -O-)"

• Your screen should look like this:
• If you ever want to use a stylus with a button, reply Y to install 'ddvk/remarkable-stylus'. This is what happens next:
• rm-hacks optionally displays a clock, but you need to set the timezone. If you need to change the timezone or set it the first time, you will get a list of all the valid responses: Find the one closest to you and type it in as you see it in the list and hit Enter. The reMarkable will restart and rm-hacks is installed!

Connecting to reMarkable from a Mac

(Coming soon)

---

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

• Clock display
• Battery and WiFi indicators
• 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)

Navigation

• Bookmarks navigation grid
• Compressed List option for document lists
• Tags are alphabetized on Menu ⇒ Tags display
• 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.

Writing

Gestures for writing

• Swipe one finger down in the body of the page to open/close toolbar.
• 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

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 for writing

• 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.
• New toolbar bookmarks button showing all bookmarks in the currently open document.
• 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.

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

Miscellaneous

• New notebook name defaults to the current date and time (format: yyyy-mm-dd_hhmmss).

---

Features Deep Dive

Gestures

Gestures include

• Open / close toolbar
• 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
• Full screen refresh
• Sleep mode

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.

Pen Button Actions

See Pen 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.