mirror of
https://github.com/amitbet/vncproxy.git
synced 2025-05-05 22:26:24 +00:00
updated docs
This commit is contained in:
parent
1307fd6d3a
commit
28c664f5cd
15
README.md
15
README.md
@ -1,15 +1,22 @@
|
||||
# VncProxy
|
||||
An RFB proxy, written in go that can save and replay FBS files
|
||||
* supports all modern encodings
|
||||
* supports regular and sockified (noVnc) server connnections
|
||||
* produces FBS files compatible with tightvnc player
|
||||
* supports all modern encodings & most useful pseudo-encodings
|
||||
* supports regular VNC TCP connections
|
||||
* supports being a "websockify" proxy (for web clients like NoVnc)
|
||||
* produces FBS files compatible with tightvnc player (while using tight's default 3Byte color format)
|
||||
* can also be used as:
|
||||
* a screen recorder vnc-client
|
||||
* a replay server to show fbs recordings to connecting clients
|
||||
|
||||
**This is still a work in progress, and requires some error handling and general tidying up,
|
||||
but the code is already working (see main, proxy_test & player_test)**
|
||||
- tested on tight encoding with: tightvnc (client+server), noVnc(web client), chickenOfTheVnc(client), vineVnc(server), tigerVnc(client)
|
||||
- tested on tight encoding with:
|
||||
- Tightvnc (client + java client + server)
|
||||
- FBS player (tightVnc Java player)
|
||||
- NoVnc(web client)
|
||||
- ChickenOfTheVnc(client)
|
||||
- VineVnc(server)
|
||||
- TigerVnc(client)
|
||||
|
||||
## Usage
|
||||
**Some very usable cmdline executables are Coming Soon...**
|
||||
|
16
todo.md
16
todo.md
@ -1,8 +1,10 @@
|
||||
#TODO:
|
||||
|
||||
* test proxy flow
|
||||
* create replay flow
|
||||
* set correct status for each flow
|
||||
* move encodings to be on the framebufferupdate message object
|
||||
* clear all messages read functions from updating stuff, move modification logic to another listener
|
||||
* message read function should accept only an io.Reader, move read helper logic (readuint8) to an actual helper class
|
||||
# TODO:
|
||||
* add replay flow to proxy
|
||||
* set correct status for each flow in proxy
|
||||
* create 2 cmdline apps (recorder & proxy) - proxy will also replay (depending on session type & cmdline flags)
|
||||
|
||||
* code stuff:
|
||||
* move encodings to be on the framebufferupdate message object
|
||||
* clear all messages read functions from updating stuff, move modification logic to another listener
|
||||
* message read function should accept only an io.Reader, move read helper logic (readuint8) to an actual helper class
|
Loading…
Reference in New Issue
Block a user