Merge pull request #1 from eddieavd/feature-autocenter

autocentering SiMuLaTiOn
eddieavd · Dec 6, 2024 · c8292de · c8292de
2 parents 87d45bf + aff46a7
commit c8292de
Show file tree

Hide file tree

Showing 78 changed files with 627 additions and 294 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,6 +1,6 @@
 cmake_minimum_required( VERSION 3.21 )
 
-project( fffb VERSION 0.0.1 )
+project( fffb VERSION 0.0.2 )
 
 set( CMAKE_CXX_STANDARD            23 )
 set( CMAKE_CXX_STANDARD_REQUIRED True )
@@ -9,17 +9,30 @@ set( CMAKE_OSX_ARCHITECTURES "x86_64" )
 
 add_compile_options( -Wall -Wextra -pedantic -Werror -fno-exceptions -O3 -DUTI_RELEASE )
 
-add_library( fffb SHARED plugin.cpp source/util.cpp source/command.cpp source/device.cpp )
+add_library( fffb SHARED plugin.cpp )
 
 target_include_directories( fffb PUBLIC
                                 include
-                                deps
-                                deps/uti
-                                deps/scs/include
-                                deps/scs/include/common
-                                deps/scs/include/amtrucks
-                                deps/scs/include/eurotrucks2
+                                include/uti
+                                include/flt
+                                include/scs/include
+                                include/scs/include/common
+                                include/scs/include/amtrucks
+                                include/scs/include/eurotrucks2
 )
-
 target_link_libraries( fffb "-framework CoreFoundation" )
 target_link_libraries( fffb "-framework          IOKit" )
+
+add_executable( flt flt.cpp )
+
+target_include_directories( flt PUBLIC
+                                include
+                                include/uti
+                                include/flt
+                                include/scs/include
+                                include/scs/include/common
+                                include/scs/include/amtrucks
+                                include/scs/include/eurotrucks2
+)
+target_link_libraries( flt "-framework CoreFoundation" )
+target_link_libraries( flt "-framework          IOKit" )
diff --git a/README.md b/README.md
@@ -4,7 +4,12 @@
 
 ## what?
 
-`fffb` is a plugin for scs games which uses the TelemetrySDK to read truck telemetry data, constructs custom forces and plays them on your logitech G923  
+### flt
+
+`flt` is a command line utility which communicates with logitech steering wheels via the [classic ffb protocol](https://opensource.logitech.com/wiki/force_feedback/Logitech_Force_Feedback_Protocol_V1.6.pdf) and can be used to configure the steering wheel directly  
+
+### fffb
+`fffb` is a plugin for [scs games](https://www.scssoft.com/) which uses the [TelemetrySDK](https://modding.scssoft.com/wiki/Documentation/Engine/SDK/Telemetry) to read truck telemetry data, constructs custom forces and plays them on your logitech G923  
 
 ## why?
 
@@ -19,7 +24,7 @@ to interact with the wheel, i use `flt`, a small library i wrote for interacting
 
 ## usage
 
-to build the plugin:  
+to build `flt` and `fffb`:  
 
 ```bash
 # clone the repo
@@ -28,7 +33,7 @@ git clone https://github.com/eddieavd/fffb && cd fffb
 # create build directory
 mkdir build && cd build
 
-# configure and build fffb
+# configure and build project
 cmake .. -DCMAKE_BUILD_TYPE=Release
 make -j8
 
@@ -44,10 +49,10 @@ cp libfffb.dylib ~/Library/Application\ Support/Steam/steamapps/common/American\
 now you can launch ets2/ats.  
 upon launch, you'll see the advanced sdk features popup, hit OK and the plugin initialization starts.  
 if the wheel leds start flashing and the wheel turns to the right and back, wheel initialization was successful and you should be good to go!  
-however, wheel initialization is a bit unstable so if you don't see the leds flash, reload the plugin by running `sdk reinit` in the in-game console
+however, wheel initialization is a bit unstable so if you don't see the leds flash, reload the plugin by running `sdk reinit` in the in-game console  
 
 ## disclaimer
 
 should work on any apple silicon mac, not tested on x86_64  
 works only with Logitech G923 PS  
-the ffb protocol is similar on other logitech wheels so it should be easy to extend support, but i don't have any other wheels and don't feel like writing code i can't test.  
+the ffb protocol is similar on other logitech wheels so it should be easy to extend support, but i don't have any other wheels and don't feel like writing code i can't test