diff options
authorNathanaƫl Sensfelder <SpamShield0@MultiAgentSystems.org>2015-09-05 10:48:59 +0200
committerNathanaƫl Sensfelder <SpamShield0@MultiAgentSystems.org>2015-09-05 10:48:59 +0200
commit259a3163e46d9c7717f6d57d7b6130fc3ef57a71 (patch)
parentdc75c584513dfd746f9819891c2eb6e77bfdf1ad (diff)
Update README.md
1 files changed, 16 insertions, 27 deletions
diff --git a/README.md b/README.md
index 699c621..a346a7c 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,28 @@
# relabsd
-Duplicates an input device to convert its relative axes into absolute ones.
-## Why would you do that?
-The main purpose of this program is to bypass an issue of 3DConnexion's SpaceNavigator (but other devices might also suffer from this issue).
-Indeed, this device reports having relatives axes despite sending absolute values.
-Here are some people having issues because of this:
-* http://www.3dconnexion.com/forum/viewtopic.php?t=2688
-* http://www.osculator.net/forum/archive/index.php/t-708.html
-* http://www.gimpusers.com/forums/gimp-developer/6231-adding-spacenavigator-support#message29509
-Relative axes make Simple DirectMedia Layer (SDL) consider the device as 2 dimentional track ball, whereas absolute ones are understood to be a 6 axis joystick (which, at least to me, seems about right).
-## How?
-### Dependencies
-* CMake
+ Turns your input devices into joysticks by converting relative axes into absolute ones.
+## Use cases
+* Use a relative input device as a joystick.
+* Bypass an issue causing your device to report its axis are relative when they are absolutes (see [the wiki page on 3DConnexion devices]() for example), this can be required by some librairies (such as Simple DirectMedial Layer - SDL) for your device to be recognized.
+## Dependencies
+* CMake (>= 3.0)
* libevdev
-### Compiling
-$ mkdir build
-$ cd build
-$ cmake ..
-### Running
-# ./relabsd /dev/input/spacenavigator ../conf/space_navigator.conf
+## How to use
+See [the related wiki page]().
### Results
(Using [Grumpel's sdl-jstest](https://github.com/Grumbel/sdl-jstest))
+Note that the real device (a 3Dconnexion SpaceNavigator, that's a 6DOF device) was made to report itself as being a joystick so it could be see by SDL. This is not required (only the virtual device has to).
**SDL 1:**
$ ./sdl-jstest --list
Found 1 joystick(s)
-Joystick Name: 'relabsd device'
+Joystick Name: 'relabsd: 3Dconnexion SpaceNavigator'
Joystick Number: 0
Number of Axes: 6
Number of Buttons: 2
@@ -56,7 +44,7 @@ Number of Balls: 1
not a gamepad
-Joystick Name: 'relabsd device'
+Joystick Name: 'relabsd: 3Dconnexion SpaceNavigator'
Joystick GUID: 030000006d04000026c6000011010000
Joystick Number: 1
Number of Axes: 6
@@ -66,6 +54,7 @@ Number of Balls: 0
not a gamepad
# Troubleshooting
## I can't find my (real) input device.
Your input device should be listed in /dev/input.