diff --git a/OpenTabletDriver.Web/Views/Wiki/Development/AddingTabletSupport.md b/OpenTabletDriver.Web/Views/Wiki/Development/AddingTabletSupport.md new file mode 100644 index 0000000..50fccae --- /dev/null +++ b/OpenTabletDriver.Web/Views/Wiki/Development/AddingTabletSupport.md @@ -0,0 +1,5 @@ +--- +title: Adding Tablet Support +--- + +#### WIP diff --git a/OpenTabletDriver.Web/Views/Wiki/Documentation/Logs.md b/OpenTabletDriver.Web/Views/Wiki/Documentation/Logs.md new file mode 100644 index 0000000..4316f50 --- /dev/null +++ b/OpenTabletDriver.Web/Views/Wiki/Documentation/Logs.md @@ -0,0 +1,23 @@ +--- +title: Logs +--- + +### GUI + +To view logs, click on the `Console` tab. Optionally, change filter from `Information` to `Debug` for more detailed logs. + +To export logs, click `Help` -> `Export diagnostics...` in the top menu bar. + +Sometimes OpenTabletDriver crashes hard. This is usually caused by a bug in OpenTabletDriver. Due to the crash, it will be impossible to retrieve the logs from GUI. In this case, you can find a partial log in the following locations: + +| OS | Location | +| --- | --- | +| Windows | `%appdata%\OpenTabletDriver\daemon.log` | +| Linux | `~/.local/share/OpenTabletDriver/daemon.log` | +| macOS | `~/Library/Application Support/OpenTabletDriver/daemon.log` | + +### Daemon + +The output from daemon is the log. + +On Linux when running daemon via systemd service, the log for daemon is recorded by systemd. To view the log, run `journalctl --user-unit opentabletdriver.service`. diff --git a/OpenTabletDriver.Web/Views/Wiki/Documentation/UdevRules.md b/OpenTabletDriver.Web/Views/Wiki/Documentation/UdevRules.md new file mode 100644 index 0000000..08bea9c --- /dev/null +++ b/OpenTabletDriver.Web/Views/Wiki/Documentation/UdevRules.md @@ -0,0 +1,51 @@ +--- +title: Udev Rules +--- + +Make sure that the installed OpenTabletDriver version is at least **0.6.3.0**. If still not working even with the latest version, refer to the instructions below depending on if you installed OpenTabletDriver via: + +- [Package manager](#package-manager) +- [Built from source](#built-from-source) + +### Package manager + +#### Standard FHS distro + +Run the following script in bash as root: + +```bash +echo "Finding old udev rules..." +for c in /etc/udev/rules.d/9{0,9}-opentabletdriver.rules; do + if [ -f "${c}" ]; then + echo "Deleting ${c}" + rm "${c}" + fi +done + +echo "Finding old kernel blacklist rules..." +if [ -f /etc/modprobe.d/blacklist.conf ]; then + echo "Deleting /etc/modprobe.d/blacklist.conf" + rm /etc/modprobe.d/blacklist.conf +done + +udevadm control --reload-rules && udevadm trigger +``` + +> This script cleans up obsolete udev rules and reloads udev. + +Then update the initramfs: + +| Distro | Command | +| --- | --- | +| Arch Linux | `sudo mkinitcpio -P` | +| Debian/Ubuntu | `sudo update-initramfs -u` | + +For other distros, refer to your distro's documentation on how to update the initramfs. + +#### Non-standard FHS distro + +Refer to your distro's documentation on how to remove udev rules of the name `90-opentabletdriver.rules` or `99-opentabletdriver.rules`. + +### Built from source + +Make sure you built OpenTabletDriver via [these instructions](https://github.com/OpenTabletDriver/OpenTabletDriver#linux) and extracted the generic binary tarball correctly. diff --git a/OpenTabletDriver.Web/Views/Wiki/FAQ/Linux.cshtml b/OpenTabletDriver.Web/Views/Wiki/FAQ/Linux.cshtml deleted file mode 100644 index 583d5fd..0000000 --- a/OpenTabletDriver.Web/Views/Wiki/FAQ/Linux.cshtml +++ /dev/null @@ -1,299 +0,0 @@ -@{ - ViewBag.Title = "Linux FAQ"; -} - -
- This occurs because another program is reading the tablet at the same time as OpenTabletDriver. - - #68 - -
- This occurs typically due to the hid_uclogic
kernel module taking priority over OpenTabletDriver.
-
- The solution to this is to rebuild the initramfs. This process varies distro to distro. -
-
- This occurs due to a lack of permissions to open a device stream.
- It is resolved by creating udev rules that give these permissions.
-
- If you installed OpenTabletDriver via your package manager,
- you may need to run the following command then replug your tablet.
-
- If this does not work, run the following commands -
-- This occurs usually when the udev rules are not correct, or haven't been reloaded. - Make sure your rules are correct by heading here. -
-If the commands above do not resolve your issue, reboot.
- -- Rebooting is the only option here. Your kernel was very likely updated, or some component of - uinput was modified which requires a reboot to resolve. -
- -
- This error occurs when the CONFIG_INPUT_UINPUT kernel option is disabled. Make sure it is activated in
- your kernel config.
-
- Check the option CONFIG_INPUT_UINPUT in /usr/src/linux.config. If it is not enabled, use the following steps -
-- Having done that, select y (for always active) or m (for building as a module) for the option in "Device Drivers - ---> - Input Device Support ---> Miscellaneous devices ---> User level driver support" and rebuild the kernel. -
-- Refer to your distribution's documentation regarding kernel configuration to enable this option. -
-- This is probably due to your kernel not having uinput built in, either build your kernel with uinput - support or use a different kernel. -
-Force full composition pipeline
in the NVIDIA settings panel.SDL_VIDEODRIVER
to wayland
.- CTL-x100 tablets boots in Android mode instead of PC mode in some rare cases. To fix this, press - the outer 2 express keys for 3-4 seconds until the LEDs change brightness. This toggles the tablet's operating mode - between PC (high LED brightness) and Android mode (low LED brightness). -
- -
- Your .xinitrc
is likely configured improperly and the DISPLAY
environment
- variable isn't set for systemd.
- Proper configuration for the .xinitrc
file can be found
- here.
-
- Note: The fix below is just a quick and dirty fix to get OpenTabletDriver running and should
- instead be resolved as above.
-
-
- Pressure support is available by changing the output mode of OpenTabletDriver to Artist Mode. - To do this, follow below. -
-
- This is most commonly the result of manufacturer driver leftovers.
+ Please check that your tablet is actually plugged in to your PC. Windows by default will indicate when a device is plugged in
+ with a sound.
If you do not get this sound consider replacing the cable (make sure the cable supports both power and data
+ transfer).
+
+ Once you are sure that your tablet is connected to your computer, ensure that your specific tablet make and model is supported by checking our list of supported tablets here.
+
+ We currently do not support tablets that connect directly to a computer via Bluetooth,
+ and there is only limited support for tablets that use wireless USB receivers, so please make sure your tablet is connected via cable.
+
+ Please make sure that you have no other tablet drivers on the system. To ensure your system is clean, follow the instructions for our Tablet Driver Cleanup Utility, then resume here.
+
+ Please check if your tablet requires WinUSB here (it will say in the notes). If it does, follow the
+ instructions and return here. Continue below for troubleshooting instructions if your tablet still isn't detected.
+
+ If you are running OpenTabletDriver.UX, navigate from the top to the Console tab, if you are running the daemon standalone, look for a log that resembles the following:
+
+
%localappdata%/OpenTabletDriver
or the contents of the userdata
folder next to the binaries (if applicable).#support-windows
channel, mentioning what you have tried.
+
+
+
+ If you want to add support for your tablet on your own, feel free to look at a similar configuration on our GitHub and our configuration documentation.
+ If you would like help with supporting your tablet, or would prefer us to do it, join our Discord and create a post in #config-creation
or a support channel.
- This occurs because another tablet driver is sending input. To resolve this,
- uninstall all other tablet drivers on your computer, then replug your tablet.
+ If your area/bindings are not working correctly despite detection, try following our troubleshooting steps below.
+
+ Make sure that you have saved your settings by pressing the save button in the bottom right of the OpenTabletDriver interface.
+
+ If you have done the above and your settings still do not apply then make sure that you don't have other drivers installed on your computer,
+ you can remove these by running and following the instructions for TabletDriverCleanup,
+ come back here.
+
+ If your cursor is teleporting you usually have another driver installed or you have broken settings, you can resolve the former by following the former with
+ TabletDriverCleanup and you can solve the latter with
+ file > reset to defaults
and clicking save.
+
+ If the issue is still unresolved after trying the instructions above, please join our Discord for extra assistance.
- Disable Map raw input to osu! window
in the ingame settings.
- OpenTabletDriver has since v0.4.0 supported Raw Input as it uses the Windows SendInput API to position the cursor.
- Therefore, it is not necessary to disable raw input itself.
+ Either disable Raw Input
in the game settings entirely or disable Map raw input to osu! window
+ in the ingame settings and make sure that sensitivity is set to 1x.
+
+ Note: OpenTabletDriver has since v0.4.0 supported Raw Input as it uses the Windows SendInput API to position the cursor. + Therefore, it is not necessary to disable raw input itself, but it provides no merit on tablets to have it enabled. +
- OpenTabletDriver has many plugins that implement different features. WindowsInk is - one of these plugins, as given in the plugins name, it allows for use of the Windows Ink pressure api. - To use it, follow below. + You can get Windows Ink pressure support with the Windows Ink plugin that is accessible through the Plugin Manager. To use it, follow the instructions below.
-+ If you already have a different installation of VMulti it is recommended that you first run + TabletDriverCleanup to avoid any potential conflicts. +
Note: Recently, a change in Windows made it so Windows Ink's and normal Mouse's cursor position is handled separately. This makes it so your cursor will appear to "jump" when switching from tablet to mouse while using Windows Ink output modes. @@ -75,25 +118,46 @@
+ This file moves OpenTabletDriver's settings to a folder called userdata next to OpenTabletDriver itself + rather than being stored in %localappdata%\OpenTabletDriver. This allows OpenTabletDriver to be completely portable, + all in one folder. +
+
- This is usually caused by one of two things. Either you didn't follow the installation guide correctly
- or the settings file is corrupted. To remedy this case follow this below.
+ This can be caused by a few different problems. Primarily, this will result from incorrectly following the installation guide on installation.
+
+ If you are sure that you have followed the installation guide correctly, or this issue just began occurring after an update to OTD, then it is likely that you have
+ broken settings or outdated plugins installed. You can remedy this with the below.
%localappdata%\OpenTabletDriver
settings.json
file from inside this folder.Plugins
folder.
+ If you have a userdata
folder next to the binaries of OpenTabletDriver, you will need to remove the files above from that folder instead.
+
+ If you still can't get it working after the solutions above please join our Discord.
+ It might be a completely different issue!
+
@@ -113,35 +177,35 @@
- When Starting OpenTabletDriver you may get an error warning you about Administrator Permissions. OpenTabletDriver
- shouldn't be run as Administrator. This causes the plugin manager, FAQ page and Tablet debugger to not work along with
- other features.
+ When Starting OpenTabletDriver you may get an error warning you about Administrator Permissions. OpenTabletDriver
+ should NEVER be run as Administrator or with Administrator permissions. This causes the plugin manager, FAQ page, and Tablet debugger to not work, and can interfere with several
+ other features.
+
+ The following instructions should fix your issue under normal circumstances, but if you're using the (disabled in a fresh windows install by default) account called "Administrator",
+ usually because you're using a "custom" iso (unofficial version of Windows, also sometimes referred to as a "debloated windows") install, these instructions will not work for you. We generally recommend against using altered or 3rd party versions of windows, as OTD is likely to not be the only software adversely affected by the changes these custom ISOs make.
User Account Control
.- If this does not solve the issue, check that you are not using the "Administrator" named account as it overrides User Account - Control. -
- This can be caused by RivaTuner Statistics Server attempting to hook onto OpenTabletDriver, preventing the UX - from responding due to failed hooks. If you use this application, make sure it doesn't hook onto OpenTabletDriver. + If you are experiencing random crashes with no warning, or the interface is completely blank and/or not accepting input, and you have RiverTuner Statistics Server + installed, it may be hooking into OpenTabletDriver and preventing the UX from functioning correctly. + If you use this application, make sure it doesn't hook onto OpenTabletDriver by blacklisting it in RiverTuner's settings.
@@ -182,4 +246,5 @@ There is no fix this, as even Logitech G Hub, Razer Synapse, HawkuTD, DevocubTD, and even XP-Pen, Huion, Gaomon, Veikk drivers are affected without exceptions. As long as the input source is not a real physical mouse, Vanguard will impose such quirks intentionally.
-Take a look at the FAQ if you encounter any problems.
diff --git a/OpenTabletDriver.Web/Views/Wiki/Install/Windows.cshtml b/OpenTabletDriver.Web/Views/Wiki/Install/Windows.cshtml index 35850d4..672a10f 100644 --- a/OpenTabletDriver.Web/Views/Wiki/Install/Windows.cshtml +++ b/OpenTabletDriver.Web/Views/Wiki/Install/Windows.cshtml @@ -77,4 +77,11 @@Replace Driver.
Take a look at the FAQ if you encounter any problems.
diff --git a/OpenTabletDriver.Web/Views/Wiki/WikiMarkdownPage.cshtml b/OpenTabletDriver.Web/Views/Wiki/WikiMarkdownPage.cshtml index 7f705e3..4fc5974 100644 --- a/OpenTabletDriver.Web/Views/Wiki/WikiMarkdownPage.cshtml +++ b/OpenTabletDriver.Web/Views/Wiki/WikiMarkdownPage.cshtml @@ -16,25 +16,16 @@ width: 65%; } - .markdown-content > table { - margin-left: 1rem; - width: calc(100% - 1rem) - } - + .markdown-content > h5, + .markdown-content > h4, .markdown-content > h3 { - margin-bottom: .5rem - } - .markdown-content > h4 { - margin-left: 1rem - } - .markdown-content > p { - margin-left: 1rem + margin-bottom: 1rem; } .markdown-content > blockquote > p { color: #888; font-size: small; - margin-left: 2rem + margin-left: 1rem; } } diff --git a/OpenTabletDriver.Web/Views/Wiki/_WikiLayout.cshtml b/OpenTabletDriver.Web/Views/Wiki/_WikiLayout.cshtml index e057c47..60a41e3 100644 --- a/OpenTabletDriver.Web/Views/Wiki/_WikiLayout.cshtml +++ b/OpenTabletDriver.Web/Views/Wiki/_WikiLayout.cshtml @@ -19,7 +19,7 @@