OpenTabletDriver 0.6.5
dotnet add package OpenTabletDriver --version 0.6.5
NuGet\Install-Package OpenTabletDriver -Version 0.6.5
<PackageReference Include="OpenTabletDriver" Version="0.6.5" />
paket add OpenTabletDriver --version 0.6.5
#r "nuget: OpenTabletDriver, 0.6.5"
// Install OpenTabletDriver as a Cake Addin #addin nuget:?package=OpenTabletDriver&version=0.6.5 // Install OpenTabletDriver as a Cake Tool #tool nuget:?package=OpenTabletDriver&version=0.6.5
OpenTabletDriver
English | 한국어 | Español | Русский | 简体中文 | Français | Deutsch
OpenTabletDriver is an open source, cross platform, user mode tablet driver. The goal of OpenTabletDriver is to be cross platform as possible with the highest compatibility in an easily configurable graphical user interface.
<p align="middle"> <img src="https://i.imgur.com/XDYf62e.png" width="410" align="middle"/> <img src="https://i.imgur.com/jBW8NpU.png" width="410" align="middle"/> <img src="https://i.imgur.com/ZLCy6wz.png" width="410" align="middle"/> </p>
Supported Tablets
All statuses of tablets that are supported, untested, and planned to be supported can be found here. Common issue workarounds can be found in the wiki for your platform.
Installation
Running OpenTabletDriver binaries
OpenTabletDriver functions as two separate processes that interact with each other seamlessly. The active program that does all of the tablet data handling is OpenTabletDriver.Daemon
, while the GUI frontend is OpenTabletDriver.UX.*
, where *
depends on your platform<sup>1</sup>. The daemon must be started in order for anything to work, however the GUI is unnecessary. If you have existing settings, they should apply when the daemon starts.
<sup>1</sup>Windows uses
Wpf
, Linux usesGtk
, and MacOS usesMacOS
respectively. This for the most part can be ignored if you don't build it from source as only the correct version will be provided.
Building OpenTabletDriver from source
The requirements to build OpenTabletDriver are consistent across all platforms. Running OpenTabletDriver on each platform requires different dependencies.
All platforms
- .NET 8 SDK (can be obtained from here - You want the SDK for your platform, Linux users should install via package manager where possible)
Windows
Run build.ps1
to produce binary builds to 'bin' folder. These builds will run in portable mode by default.
Linux
Required packages (some packages may be pre-installed for your distribution):
- libx11
- libxrandr
- libevdev2
- GTK+3
Run ./eng/linux/package.sh
. If a "package" build is desired,
there are official support for the following packaging formats:
Package Format | Command |
---|---|
Generic binary tarball (.tar.gz ) |
./eng/linux/package.sh --package BinaryTarBall |
Debian package (.deb ) |
./eng/linux/package.sh --package Debian |
Red Hat package (.rpm ) |
./eng/linux/package.sh --package RedHat |
The generic binary tarball is designed to be extracted from the root directory.
MacOS [Experimental]
Run ./eng/macos/package.sh --package true
.
Features
- Fully platform-native GUI
- Windows:
Windows Presentation Foundation
- Linux:
GTK+3
- MacOS:
MonoMac
- Windows:
- Fully fledged console tool
- Quickly acquire, change, load, or save settings
- Scripting support (json output)
- Absolute cursor positioning
- Screen area and tablet area
- Center-anchored offsets
- Precise area rotation
- Relative cursor positioning
- px/mm horizontal and vertical sensitivity
- Pen bindings
- Tip by pressure bindings
- Express key bindings
- Pen button bindings
- Mouse button bindings
- Keyboard bindings
- External plugin bindings
- Saving and loading settings
- Auto-loads user settings via
settings.json
in the active user%localappdata%
or.config
settings root directory.
- Auto-loads user settings via
- Configuration Editor
- Allows you to create, modify, and delete configurations.
- Generate configurations from visible HID devices
- Plugins
- Filters
- Output modes
- Tools
Contributing to OpenTabletDriver
If you wish to contribute to OpenTabletDriver, check out the issue tracker. When creating pull requests, follow the guidelines outlined in our contribution guidelines.
If you have any issues or suggestions, open an issue ticket and fill out the template with relevant information. We welcome both bug reports, as well as new tablets to add support for. In many cases adding support for a new tablet is quite easy.
For issues and PRs related to OpenTabletDriver's packaging, please see the repository here.
For issues and PRs related to OpenTabletDriver's web page, see the repository here.
Supporting a new tablet
If you'd like us to add support for a new tablet, open an issue or join our discord asking for support. We generally prefer that adding support for a tablet be done through discord, due to the back-and-forth involved.
We'll have you do a few things like making a recording of the data sent by your tablet using our built-in tablet debugging tool, testing features of the tablet (on-tablet buttons, pen buttons, pen pressure, etc) with different configs we'll send you to try.
You're also of course welcome to open a PR adding support for it yourself, if you have a good grasp on what's involved.
Generally this process is relatively easy, especially if it's for a tablet manufacturer we already have support for on other tablets.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- HidSharpCore (>= 1.2.1.1)
- Microsoft.Extensions.DependencyInjection (>= 6.0.0-rc.1.21451.13)
- Newtonsoft.Json (>= 13.0.1)
- OpenTabletDriver.Configurations (>= 0.6.5)
- OpenTabletDriver.Native (>= 0.6.5)
- OpenTabletDriver.Plugin (>= 0.6.5)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on OpenTabletDriver:
Package | Downloads |
---|---|
ppy.osu.Framework
A 2D application/game framework written with rhythm games in mind. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on OpenTabletDriver:
Repository | Stars |
---|---|
ppy/osu-framework
A game framework written with osu! in mind.
|
Version | Downloads | Last updated |
---|---|---|
0.6.5 | 3,065 | 11 days ago |
0.6.4 | 160,959 | 12/23/2023 |
0.6.3 | 54,853 | 9/17/2023 |
0.6.1 | 44,520 | 6/21/2023 |
0.6.0.4 | 218,689 | 7/12/2022 |
0.6.0.2 | 156,902 | 1/17/2022 |
0.6.0 | 146 | 1/11/2022 |
0.5.3.1 | 401,076 | 4/13/2021 |
0.5.3 | 1,410 | 4/13/2021 |
0.5.2.3 | 14,765 | 3/17/2021 |
0.5.2.2 | 830 | 3/12/2021 |
0.5.2.1 | 5,754 | 3/10/2021 |
0.5.2 | 801 | 3/8/2021 |
0.5.1.2 | 776 | 2/19/2021 |
0.5.1.1 | 759 | 2/19/2021 |
0.5.1 | 789 | 1/30/2021 |
0.5.0 | 846 | 1/19/2021 |