From c82b79fab336768900cd069ea69cc82f294d2f9f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Michal=20Mal=C3=BD?= Date: Mon, 27 Jul 2015 14:28:19 +0200 Subject: [PATCH] Add README file. --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d57820f --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +FFBChecker +=== + +Description +--- +This tool of a very unimaginative name is mainly intended to test implementation of [Force Feedback](https://en.wikipedia.org/wiki/Haptic_technology) on Linux systems. It has a Qt5-based GUI that allows the user to set up parameters of the effects and play them back on their devices. Only Linux Force Feedback API is supported at the moment. Support for other interfaces ([SDL2](https://www.libsdl.org/), [DirectInput](https://msdn.microsoft.com/en-us/library/windows/desktop/ee418273(v=vs.85).aspx)) might be added in the future. + + +Usage +--- +Choose the device on which you want to play the effects from the *Devices* combobox. If the desired device does not appear in the menu, try clicking *Refresh* to update the list of detected devices. Devices that you do not have access to due to insufficient privileges will **not** appear in the list. Once the device has been selected and successfully opened by FFBChecker you can set up effect parameters using the entry fields below. + + +Remarks +--- + + * Effects of finite duration will still be listed as *Playing* by the GUI. Most Linux Force Feedback drivers do not report back when a finite effect has finished playing and FFBChecker does not currently check for respective event anyway. + * Clicking the *Start* button will upload the effect automatically if the effect has not been uploded before. Similar thing applies for the *Remove* button which stops the effect before it tries to remove it from the device. + * Clicking *Upload/Update* button on a playing effect will issue "live" update of the effect's parameters. + * Clicking *Start* when the selected effect is listed as *Playing* has no effect even if the parameters of the effect have changed or if the effect has finished playing. Use the *Stop* button to stop the effect and then *Start* again to restart it. + * Clicking *Start* when the selected effect is already listed as *Uploaded* does **not** update the parameters of the effect. If you adjusted the parameters after the effect had been uploaded, use the *Upload/Update* to pass the new parameters to your device. + + +Build/Installation +--- + +cd into the source directory and run: + + mkdir build + cd build + ../qmake + make + +Note that some Linux distributions may provide `qmake-qt5` and `qmake-qt4` to target different version of the Qt framework. In such a case run `qmake-qt5` instead of qmake. + +To launch FFBChecker, run: + + ./FFBChecker -- 2.43.5