Skip to content

Commit

Permalink
Wording, clarifications, fix link to blog post
Browse files Browse the repository at this point in the history
  • Loading branch information
phoboslab committed Jul 27, 2015
1 parent 22f3be7 commit 8d34d7d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# jsmpeg-vnc

A low latency, high framerate screen sharing solution, viewable in any modern browser.
A low latency, high framerate screen sharing server and client, viewable in any modern browser.

[More Info & Demo Video](http://phoboslab.org/log/2015/07/play-gtav-in-your-browser-sort-of)
[More Info & Demo Video](http://phoboslab.org/log/2015/07/play-gta-v-in-your-browser-sort-of)

[Download Binaries](https://github.com/phoboslab/jsmpeg-vnc/releases)

Expand All @@ -19,7 +19,7 @@ Options:
-p port (default: 8080)
Use "desktop" as the window name to capture the whole Desktop. Use "cursor"
to use the window at the current cursor position.
to capture the window at the current cursor position.
Full Example:
jsmpeg-vnc.exe -b 2000 -s 640x480 -f 30 -p 9006 "Quake 3: Arena"
Expand All @@ -36,9 +36,9 @@ Capturing and encoding 1920x1080 video narrowly amounts to 60fps on my system an

## Technology & License

This App uses [ffmpeg](https://github.com/FFmpeg/FFmpeg) for encoding, [libwebsockets](https://github.com/warmcat/libwebsockets) for the WebSocket server and [jsmpeg](https://github.com/phoboslab/jsmpeg) for decoding in the browser. Note that the jsmpeg version in this repository has been hacked to get rid of an extra frame of latency. The server sends each frame with a custom header, so the resulting WebSocket stream is not a valid MPEG video anymore.
This App uses [ffmpeg](https://github.com/FFmpeg/FFmpeg) for encoding, [libwebsockets](https://github.com/warmcat/libwebsockets) for the WebSocket server and [jsmpeg](https://github.com/phoboslab/jsmpeg) for decoding in the browser. Note that the jsmpeg version in this repository has been modified to get rid of an extra frame of latency. The server sends each frame with a custom header, so the resulting WebSocket stream is not a valid MPEG video anymore.

The client application (the thing that runs in the browser) is very rudimentary. In particular, the mobile version has some quirks and only has touch buttons for the arrow keys, ESC and Enter, though this can be easily extended.
The client application (the thing that runs in the browser) is very rudimentary. In particular, the mobile version has some quirks with mouse input and only has touch buttons for the arrow keys, ESC and Enter, though this can be easily extended.

jsmpeg-vnc is published under the [GPLv3 License](http://www.gnu.org/licenses/gpl-3.0.en.html).

Expand Down
2 changes: 1 addition & 1 deletion source/jsmpeg-vnc.c
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ void exit_usage(char *self_name) {
" -p port (default: 8080)\n\n"

"Use \"desktop\" as the window name to capture the whole Desktop. Use \"cursor\"\n"
"to use the window at the current cursor position.\n\n"
"to capture the window at the current cursor position.\n\n"

"To enable mouse lock in the browser (useful for games that require relative\n"
"mouse movements, not absolute ones), append \"?mouselock\" at the target URL.\n"
Expand Down

0 comments on commit 8d34d7d

Please sign in to comment.