aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Berger <j.david.berger@gmail.com>2018-03-16 18:03:34 -0600
committerJustin Berger <j.david.berger@gmail.com>2018-03-16 18:03:34 -0600
commit1fe0debd6474c0368f81159cd6a0451edbc6d381 (patch)
tree1d5b63702ce57b665185919c0431714d53747047 /README.md
parente175d0bd2e51263934086f7898911af4e2ce4ab7 (diff)
downloadlibsurvive-1fe0debd6474c0368f81159cd6a0451edbc6d381.tar.gz
libsurvive-1fe0debd6474c0368f81159cd6a0451edbc6d381.tar.bz2
Added a lot of features to the viz tool
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index a4fd656..4dce4f9 100644
--- a/README.md
+++ b/README.md
@@ -280,6 +280,22 @@ To actually replay it, put that directory path in the 'PlaybackFile' configurati
There is also a config variable -- `PlaybackFactor` -- which adjusts the speed at which playback happens. A value of 1 emulates the same time the events file took to create, a value of 0 streams the data in as fast as possible.
+# Visualization
+
+- Download and install: http://websocketd.com/
+- Build the repo
+- Run `data_recorder` through `websocketd` like so:
+
+``` websocketd --port=8080 ./data_recorder```
+
+- Navigate to the `/tools/viz/index.html` page in chrome.
+
+Nothing will happen until you connect to that page. When you do, the app lifetime will be bound to that session -- reloading the page will reload data_recorder.
+
+The arrow keys will move you to the left / right / up / down and the UI response to orbital mouse controls.
+
+![Visuzliation Screenshot](https://raw.githubusercontent.com/cnlohr/libsurvive/master/useful_files/viz_screenshot.jpg)
+
## Notes about coordinate frames.
BELOW IS NOT FINALIZED!!!!