diff --git a/.Jules/palette.md b/.Jules/palette.md new file mode 100644 index 000000000..213299d58 --- /dev/null +++ b/.Jules/palette.md @@ -0,0 +1,7 @@ +# Palette's Journal - UX & Accessibility Learnings + +This journal is used to record critical UX and accessibility learnings discovered during the development of lmuFFB. + +## 2026-04-18 - [Initial Entry] +**Learning:** Documentation is often the first touchpoint for a user. Inconsistent numbering, typos, and poor visual cues for warnings can create friction and reduce trust before the app is even launched. +**Action:** Prioritize fixing documentation flow and using standard alert components (like GitHub's [!WARNING]) to guide users through complex setup processes. diff --git a/README.md b/README.md index 91ecc50fb..9eb4b3a79 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A Telemetry-based Force Feedback app for LMU, somewhat inspired by irFFB and Mar Experimental alpha version. -![lmuFFB GUI](docs/screenshots/v0.7.296.png) +![lmuFFB main interface showing FFB settings, presets, and device selection. The GUI includes sliders for Master Gain, Wheelbase Max Torque, and various force effects.](docs/screenshots/v0.7.296.png) ## 📥 Download @@ -17,11 +17,6 @@ Experimental alpha version. > [!IMPORTANT] > **Folder Location**: To avoid write permission issues (unable to save settings or `config.ini` errors), **do NOT** place the lmuFFB folder in `C:\Program Files`. Instead, keep it in a location where the app has full write access, such as a subfolder in your **Downloads** folder. -**B. Configure lmuFFB** -1. Run `LMUFFB.exe`. -2. **FFB Device**: In the dropdown, select your **Physical Wheel** (e.g., "Simucube 2 Pro", "Fanatec DD1"). -3. **Master Gain**: Start low (0.5) and increase. - **A. Configure Le Mans Ultimate (LMU)** 1. Start LMU. 2. Go to **Settings > Graphics**: @@ -29,10 +24,15 @@ Experimental alpha version. 3. Go to **Controls > Force Feedback**. 4. **Steering Axis**: Bind to your **Physical Wheel** (e.g., Simucube, Fanatec, Moza, Logitech). 5. **In-Game Force Feedback settings in LMU**: - * In-game Force Feedback can be left **Enabled and with Strength % greater than zero**. - * It is necessary to have it enabled (and greater than zero) if you want to use the option to also transmit the in-game FFB through the lmuFFB app. The FFB strength % you set in-game will be exactly the strength lmuFFB receives (before applying any other setting). So set in-game FFB strenght to the value you generally prefer for in-game FFB when not using the app. + * Set in-game **Force Feedback Strength to 100%**. This ensures the app receives the full dynamic range of the signal. You can then manage the overall strength using the app's Master Gain. + * Ensure in-game Force Feedback is **Enabled**. It is necessary to have it enabled if you want to use the option to also transmit the in-game FFB through the lmuFFB app. + +**B. Configure lmuFFB** +6. Run `LMUFFB.exe`. +7. **FFB Device**: In the dropdown, select your **Physical Wheel** (e.g., "Simucube 2 Pro", "Fanatec DD1"). +8. **Master Gain**: Start low (0.5) and increase. -4. **Drive!** You should feel force feedback generated by the app. +9. **Drive!** You should feel force feedback generated by the app. ## 🧪 Experimental Version - Testing Needed! diff --git a/docs/user_guides/introduction.md b/docs/user_guides/introduction.md index 3658d4904..cf04d2cb5 100644 --- a/docs/user_guides/introduction.md +++ b/docs/user_guides/introduction.md @@ -1,6 +1,7 @@ # Introduction to LMUFFB -> This document is not up to date, it is based on an older version of the app. -TODO: update this document, vJoy is no longer used, all references to it should be removed or updated / reworded appropriately. + +> [!WARNING] +> This document is not up to date and is based on an older version of the app. **LMUFFB** (Le Mans Ultimate Force Feedback) is a specialized high-performance application designed to enhance the driving experience in the *Le Mans Ultimate* simulator. Its primary goal is to provide **Force Feedback (FFB)** signals that communicate tire physics—specifically tire grip and loss of traction—more effectively than the game's native output. diff --git a/docs/user_guides/the_physics_of__feel_-_driver_guide.md b/docs/user_guides/the_physics_of__feel_-_driver_guide.md index 8a19ecd3c..c2965988d 100644 --- a/docs/user_guides/the_physics_of__feel_-_driver_guide.md +++ b/docs/user_guides/the_physics_of__feel_-_driver_guide.md @@ -1,5 +1,7 @@ # The Physics of Feel: LMUFFB Driver's Guide -> This document is not up to date, it is based on an older version of the app. + +> [!WARNING] +> This document is not up to date and is based on an older version of the app. This guide explains how LMUFFB translates raw telemetry data into tactile sensations. It details what you should feel in specific driving situations and provides a blueprint for visualizing these relationships through telemetry graphs.