Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,25 @@

![Logo](artworks/plato-logo.svg)

*Plato* is a document reader for *Kobo*'s e-readers.
This is a fork of the [Plato document reader](https://github.com/baskerville/plato) for the reMarkable tablet. It has been modified to use [libremarkable](https://github.com/canselcik/libremarkable) for rendering.

It was tested on the following devices:
## Installation

- *Aura ONE* (FW 4.7.10413).
- *Glo HD* (FW 4.7.10413 and 3.19.5761).
- *Aura H₂O Edition 2*.
- *Aura Edition 2*.
- *Glo*.
- *Touch C*.
Download a release zip from [Releases](http://github.com/darvin/plato/releases) and copy it to the reMarkable.

## Supported formats
``` bash
mkdir /home/root/plato
mv plato_release.zip /home/root/plato
cd /home/root/plato
unzip plato_release.zip
./remarkable_install.sh
```

- PDF, ePUB and CBZ via *mupdf*.
- DJVU via *djvulibre*.
Stop xochitl with `systemctl stop xochitl`.

## Features
Start Plato with `systemctl start plato`.

- Hierarchical categories.
- The metadata for each document is read from a single JSON file.
- Crop margins of non-reflowable documents.
## Screenshots

[![Tn01](artworks/thumbnail01.png)](artworks/screenshot01.png) [![Tn02](artworks/thumbnail02.png)](artworks/screenshot02.png)

Expand Down
11 changes: 11 additions & 0 deletions plato.service
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[Unit]
Description=plato reader

[Service]
WorkingDirectory=/home/root/plato
Environment="LD_LIBRARY_PATH=libs"
ExecStart=/home/root/plato/plato
Restart=always

[Install]
WantedBy=multi-user.target
26 changes: 26 additions & 0 deletions remarkable_install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#!/bin/bash
# Install plato systemd unit

# quit if we get any errors
set -e

# check for correct unarchive path
unarchived_dir=$(
cd $(dirname "$0")
pwd
)
if [[ ! $unarchived_dir = /home/root/plato ]]
then
echo "Detected incorrect path. Please unarchive tarball in /home/root/plato/"
exit
fi

# create books/
if [[ ! -d $HOME/books ]]
then
mkdir $HOME/books
fi

# install systemd unit
cp plato.service /etc/systemd/system
systemctl daemon-reload
28 changes: 28 additions & 0 deletions settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"libraryPath": "/home/root/books",
"refreshEvery": 24,
"summarySize": 1,
"import": {
"unmountTrigger": true,
"allowedKinds": [
"fb2",
"epub",
"cbz",
"jpeg",
"png",
"djvu",
"html",
"jpg",
"pdf"
]
},
"reader": {
"finished": "notify"
},
"frontlightLevels": {
"intensity": 0.0,
"warmth": 0.0
},
"frontlight": true,
"wifi": false
}