You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-37Lines changed: 17 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,8 +38,9 @@ When running on the Remarkable Paper Pro, `RLE_COMPRESSION` environment variable
38
38
-**Laser Pointer**: Features a laser pointer that activates on hovering.
39
39
-**Gesture Support**: Full integration with Reveal.js, allowing slide switching directly from the reMarkable.
40
40
-**Overlay Feature**: Allows overlaying over existing websites that support iframe embedding.
41
-
-**Built-in Ngrok**: Enables streaming over different networks easily.
42
41
-**Live Parameter Tweaking**: Side menu for live adjustments, including screen rotation.
42
+
-**Dark Mode**: Toggle between light and dark themes for comfortable viewing in any environment.
43
+
-**Version API**: Check the current version via the `/version` endpoint.
43
44
44
45
## Quick Start
45
46
@@ -173,23 +174,12 @@ Add query parameters to the URL (`?parameter=value&otherparameter=value`):
173
174
- `rate`: (integer, 100-...) Set the frame rate.
174
175
- `flip`: (true/false) Enable or disable flipping 180 degree.
175
176
176
-
## Tunneling
177
-
Tunneling with built-in Ngrok allows for streaming across different networks.
178
-
This feature is particularly useful for remote presentations or collaborative sessions.
179
-
To set up tunneling, simply enable Ngrok in the tool's settings and follow the instructions provided in the user interface.
180
-
181
-
If your reMarkable is on a different network than the displaying device, you can use the `ngrok` builtin feature for automatic tunneling.
182
-
To utilize this tunneling, you need to sign up for an ngrok account and [obtain a token from the dashboard](https://dashboard.ngrok.com/get-started/your-authtoken).
183
-
Once you have the token, launch reMarkable using the following command:
The app will start, displaying a message similar to:
188
-
189
-
`2023/09/29 16:49:20 listening on 72e5-22-159-32-48.ngrok-free.app`
190
-
191
-
Then, connect to `https://72e5-22-159-32-48.ngrok-free.app` to view the result.
192
-
177
+
### API Endpoints
178
+
- `/`: Main web interface
179
+
- `/stream`: The image data stream
180
+
- `/events`: WebSocket endpoint for pen input events
181
+
- `/gestures`: Endpoint for touch events
182
+
- `/version`: Returns the current version of goMarkableStream
193
183
194
184
## Presentation Mode
195
185
`goMarkableStream` introduces an innovative experimental feature that allows users to set a presentation or video in the background, enabling live annotations using a reMarkable tablet.
@@ -218,9 +208,9 @@ This includes a variety of presentation and video platforms.
218
208
Switch slides or navigate through your presentation directly from your reMarkable tablet.
219
209
This seamless integration enhances the experience of both presenting and viewing, making it ideal for educational and professional environments.
220
210
221
-
Howto: add the `?present=https://your-reveal-js-presentation`
211
+
How to: add the `?present=https://your-reveal-js-presentation`
222
212
223
-
_note_: due to browser restrictions, the URL mus
213
+
_note_: due to browser restrictions, the URL must be HTTPS.
224
214
225
215
### Limitations and Performance
226
216
@@ -229,12 +219,12 @@ _note_: due to browser restrictions, the URL mus
229
219
Users must use the side menu for navigation and control.
230
220
- This feature operates seamlessly, with no additional load on the reMarkable tablet, as all rendering is done in the client's browser.
231
221
232
-
### Feedback and Contributions
222
+
### UI Features
233
223
234
-
- As this is an experimental feature, your feedback is crucial for its development.
235
-
Please share your experiences, suggestions, and any issues encountered using the GitHub issues section of this repository.
236
-
237
-
---
224
+
- **Dark Mode**: Toggle between light and dark themes using the sun/moon icon in the sidebar
225
+
- **Modern Interface**: Improved UI with better typography and layout
226
+
- **Tooltips**: Helpful tooltips on hover for all buttons
227
+
-**Feedback Messages**: Visual feedback for user actions
238
228
239
229
## Technical Details
240
230
@@ -246,16 +236,7 @@ This tool suits my need and is an ongoing development. You can find various info
246
236
247
237
This is a standalone application that runs directly on a Remarkable tablet.
248
238
It does not have any dependencies on third-party libraries, making it a completely self-sufficient solution.
249
-
This application exposes an HTTP server with two endpoints:
250
-
### Endpoints
251
-
252
-
- `/`: This endpoint serves an embedded HTML and JavaScript file containing the necessary logic to display an image from the Remarkable tablet on a client's web browser.
253
-
254
-
- `/stream`: This endpoint streams the image data from the Remarkable tablet to the client continuously.
255
-
- `/events`: This endpoint streams the pen input events via websockets
256
-
- `gestures`: This endpoints streams the touch events in binary
257
-
258
-
**Caution**: the API may change over time
239
+
This application exposes an HTTP server with several endpoints.
259
240
260
241
### Implementation
261
242
@@ -296,5 +277,4 @@ Feel free to modify, distribute, and use the tool in accordance with the terms o
296
277
## Tipping
297
278
298
279
If you plan to buy a reMarkable 2, you can use my [referal program link](https://remarkable.com/referral/PY5B-PH8U).
299
-
It will provide a discount for you and also for me.
300
-
280
+
It will provide a discount for you and also for me.
0 commit comments