aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 20 insertions, 10 deletions
diff --git a/README.md b/README.md
index f9d5ba6..c7094c0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Linux kernel module for Thrustmaster T300RS, T248 and TX (experimental) wheels
+# Linux kernel module for Thrustmaster T300RS, T248 and (experimental) TX and TS-XW wheels
> **DISCLAIMER:** The module is now ready for near-stable USE in most force
> feedback games, supports rangesetting as well as gain and autocentering along
@@ -13,8 +13,8 @@
## Description
-A Linux kernel module for Thrustmaster T300RS, T248, and TX
-(experimental support) wheels.
+A Linux kernel module for Thrustmaster T300RS, T248, and (experimental support)
+TX and TS-XV wheels.
I've been working on enhancing the real-time updating of effects, and although
it's not flawless yet, the overall experience is gradually improving. There are
@@ -25,13 +25,22 @@ recognized by the games, they might not be mapped correctly.
I only have access to the base editions of T300RS and T248 wheels to test with, but
from reports it seems that other editions (F1, GT, Alcantara, etc.) should also work
-with this driver. TX support was contributed by
-[@davidedmundson](https://github.com/davidedmundson).
+with this driver.
+
+TX support was contributed by
+[@davidedmundson](https://github.com/davidedmundson),
+TS-XW support was contributed by
+[@yassineimounachen](https://github.com/yassineimounachen).
## Installation
You can either install this kernel module by using DKMS or
-manually building from source:
+manually building from source. If you're unsure which to pick,
+go with DKMS, it will automatically recompile the driver
+whenever needed.
+
+An AUR package is also available:
+[hid-tmff2-dkms-git](https://aur.archlinux.org/packages/hid-tmff2-dkms-git)
### Dependencies
@@ -41,6 +50,7 @@ one of the right command for your distribution:
```shell
sudo apt install linux-headers-$(uname -r) # Debian-based
sudo pacman -S linux-headers # Arch-based
+sudo pacman -S linux-neptune-61-headers # For SteamDeck specifically
sudo yum install kernel-devel kernel-headers # Fedora-based
```
@@ -76,8 +86,8 @@ sudo yum install kernel-devel kernel-headers # Fedora-based
> (completely optional), see
> [here](https://www.kernel.org/doc/html/latest/admin-guide/module-signing.html).
-> **NOTE:** Thrustmaster TX wheels aren't supported by `hid-tminit` as of yet,
-> meaning that TX wheels have to be initialized with `tmdrv`. Please see
+> **NOTE:** Thrustmaster TX and TS-XW wheels aren't supported by `hid-tminit` as of yet,
+> meaning that the wheels have to be initialized with `tmdrv`. Please see
> https://github.com/Kimplul/hid-tmff2/issues/48.
> **WARNING:** There have been reports that this driver does not work if
@@ -103,7 +113,7 @@ for wheels:
+ [T500 RS](https://github.com/Kimplul/hid-tmff2/issues/18)
+ [T818](https://github.com/Kimplul/hid-tmff2/issues/58)
+ [T-GT II](https://github.com/Kimplul/hid-tmff2/issues/55)
-+ [T128P](https://github.com/Kimplul/hid-tmff2/issues/67)
++ [T128P](https://github.com/Kimplul/hid-tmff2/issues/67) (initial alpha support, needs `hid-tminit` tweaking)
+ [TS-PC](https://github.com/Kimplul/hid-tmff2/issues/65)
## Common issues and notes
@@ -123,7 +133,7 @@ for wheels:
[upstreamed](https://github.com/scarburato/hid-tminit), you might want to
blacklist the kernel module `hid-thrustmaster`. Do this with
```shell
- echo 'blacklist hid_thrustmaster' > /etc/modprobe.d/hid_thrustmaster.conf
+ echo 'blacklist hid_thrustmaster' | sudo tee /etc/modprobe.d/hid_thrustmaster.conf
```
+ If you've bought a new wheel, you will most likely have to update the firmware