reMarkable Splasher

These scripts are to be used at your own risk, and come with no gaurenttees. Back up your device before running, and know how to restore the back up. It's possible that this script could brick your device. Use with caution

reMarkable Spashes utility script that allows for the management and upload of templates (and:soon: splash screens) to be uploaded to the remarkable2 device. These script will not preserve any existing custom templates by default.

Dependencies

• nc
• jq
• ssh
• pngquant

For ssh setup help see the reMarkableWiki

Usage

Upload template images to the device

rm2-templates [-v | -h ]

Copy custom tempates to the device

rm2-compress [-v | -h ]

Storage is at a premium on the remarkable2 device. Use this script to compress images in the ./templates directory before uploading them to the device.

Adding Templates

Add new template files to the ./source/rm2-splashes.sketch file. Ensure dimensions are correct. Compress images before adding to this file.

Each template file is a new page. Name the page and the canvas following the convention {Category} | {Name}. {Category} is the name of the category that this template will appear under on the device. {Name} is the template name on the device.

Export .pngs and optionally .svg to the project ./templates directory.

Copy from the device your existing ./source/templates.json. Place it in this directory, replacing the existing file in the repository. Add an attribution in the attributions file

Preserving Existing Custom Templates

This script will not preserve any of your existing installed custom templates. However, can preserve these templates with some additional work. Built in support for this may come in the future.

Troubleshooting

See here for further troubleshooting