search

Fredobedo / openFFB

5 stars 2 forks source link

readme

openFFB

Introduction

The goal of this project is to use consumer FFB Racing wheels on Arcade racing cabs/systems.
The user can take an USB Racing Wheel which support Force Feedback effects (i.e. Logitech GT), connect it to a Single Board Computer (i.e. a raspberry PI) and enjoy FFB effects with arcade games.

This can be achieved thanks to an interface between the arcade System and the SBC, called "Sega FFB Controller" that you can get from Aganythe. (c/o https://www.gamoover.net/Forums/index.php?topic=42310.0)

Please note that this Sega FFB Controller may achieve far more possibilities depending on the firmware we inject but this will not be covered here (i.e. act as an interface between a PC and a racing cab).

available

But wait, arcade Systems like Naomi, Chihiro, Triforce, etc. require a connection to a JVS IO Board (arcade controller interface). This is required here in our Use Case, by the System to retrieve Wheel's position, pedals, etc.

For this pupose, we use "OpenJVS", a Software JVS IO Board, that also can run on a Raspberry PI.

available

But wait, how can we use it?
"Wipi", a Web Application Interface has also been created for the best End User experience, helping users in configuring and using "OpenJVS", "OpenFFB" and has NetDimm support too.

"WiPi" can be found as a full image, ready to be used, with all pre-configured, please read below paragraph for more information.

available

Dependencies

Installation and Running

THE FOLLOWING INFORMATION IS ONLY USEFULL FOR PERSONS WILLING TO INTEGRATE OPENFFB MANUALLY IN THEIR SOLUTION/BUILD.
PEOPLE MAY USE THE "READY TO GO WIPI" INSTEAD, WHICH OFFERS ALL NECESSARY WEB INTERFACE TO USE AND MANAGE IT.

Installation may be done like this:

git clone https://github.com/Fredobedo/openFFB
cd openFFB
mkdir build
cd build 
cmake ..
make
cmake --install .

file structure after installation:

Location Description
/usr/local/bin/openffb Executable
/etc/openffb/config Main configuration file
/etc/openffb/games/generic-driving Default FFB effect settings
/etc/openffb/games/generic-driving-no-ffb-support A game profile for games not supporting FFB
/etc/openffb/games/initial-d A specific game profile for a game

Please have a look at the help menu to have a first insight on OpenFFB: help

Test your racing wheel

  1. First verify that your wheel is detected:
    available

  2. Then, test if your linux distribution is supporting FFB effects for your racing wheel:
    supported

  3. Now, you can start OpenFFB:
    start

Configuration

You can dump the actual OpenFFB like this:
start

Installation drivers for Logitech Racing wheels

Most of the Logitech Racing wheels are not supported in Linux. Fortunatelly, 'new-lg4ff' is a custom driver that you can install and which will support most of the FFB effects too. More information at https://github.com/berarma/new-lg4ff.

This driver is normally present on Wipi distribution but if you want to use another distribution or update the existing Wipi, here is an example of how you can do it:

PS: Thanks to stefanpausch for mentioning it :)

Wiring

Here is a Physical view of Wiring between a Chihiro System and Sega FFB Controller:
start

WiPi: Example of a successfull full integration

https://youtube.com/shorts/_WRH8y1oFbs?si=pga3aIkp4NRZnSt3

External references

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.