deploy: 0ddc16a

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: d93caac27d73a584726622eaee9ec558
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/faq/basic.md.txt

@@ -0,0 +1,20 @@
+# Basic
+
+- Q: Can i prevent my cursor from moving when i use certain gestures?
+  - A: Not currently, it is possible to cancel inputs via plugins, but i'm not sure on how to obtain the best of both worlds.
+
+<br>
+
+- Q: Can i use this without a touch tablet?
+    - A: Not currently, however, i do think that being able to trigger single-touch gestures with just a pen would be a good idea
+         (Soft Keys comes to mind).
+
+<br>
+
+- Q: Can i specify which tablet to configure?
+    - A: You can change the configured tablet the same way as OpenTabletDriver 0.6,x, using a dropdown located at the bottom left of the interface.
+         It is however only available in the 0.6.x version as it's the only version that currently supports multiple tablets.
+
+<br>
+
+This section is still in construction, if you have any questions, feel free to ask them on the [Github Discussions](https://github.com/Mrcubix/Touch-Gestures/discussions)

_sources/faq/index.rst.txt

@@ -0,0 +1,10 @@
+.. _faq:
+
+Frequently Asked Questions
+==========================
+
+.. toctree:: 
+    :maxdepth: 1
+
+    basic
+    troubleshooting

_sources/faq/troubleshooting.md.txt

@@ -0,0 +1,19 @@
+# Troubleshooting
+
+- Q: The Plugin does not seem to work.
+    - A: Make sure that you have followed the installation guide carefully, and that you have the correct dependencies installed. \
+         If the plugin has initialized properly, you should see any of the following lines in OpenTabletDriver's console:
+         ```log
+         [Touch Gestures Daemon:Info] Initialized
+         [Touch Gestures:Info] Now handling touch gesture for: Wacom CTH-470
+         ```
+         At that point you should also be able to trigger the gestures you have set up & you the interface should be able to connect to the plugin.
+
+<br>
+
+- Q: The driver does not seem to go past 'Waiting for debugger to attach...' in the console.
+    - A: Oops, i may have forgot to set the build configuration to Release instead of Debug, let me know on github if this is the case.
+
+<br>
+
+This section is still in construction, if you have any questions, feel free to ask them on the [Github Discussions](https://github.com/Mrcubix/Touch-Gestures/discussions)

_sources/getting_started/deleting_gestures.md.txt

@@ -0,0 +1,21 @@
+# Deleting a Gestures
+
+To delete a gesture, you can click the red `-` button on the right most side of a gesture.
+
+```{figure} img/binding_display_delete_highlighted.png
+:alt: Binding Display (Delete Highlighted)
+:width: 100%
+```
+
+Once you have clicked it, a confirmation dialog will appear. Choose `Yes` to delete the gesture, or `No` to cancel the deletion.
+
+```{figure} img/delete_gesture_confirmation_dialog.png
+:alt: Delete Gesture Confirmation Dialog
+:align: center
+```
+
+If you have removed a gesture by accident, and have not yet clicked on the `Save` button, you can restart the application to restore the deleted gesture.
+
+%```{note}
+%There are plans to add an undo feature for deletions in the future.
+%```

_sources/getting_started/editing_gestures.md.txt

@@ -0,0 +1,22 @@
+# Editing an existing Gesture
+
+Now that you have set up a gesture, you may want to edit it. \
+If you only want to change the binding, you can do so without clicking on the `Edit` button, \
+using the same means as in OpenTabletDriver.
+
+Otherwise, you might want to for instance change the options or the tweaks of the gesture.
+In this case, you will need to click on the `Edit` button.
+
+```{figure} img/binding_display_edit_highlighted.png
+:alt: Binding Display (Edit Highlighted)
+:width: 100%
+```
+
+After clicking on the `Edit` button, you will be taken to the setup screen of the gesture. \
+From there, you can proceed to change settings as if you were setting up a new gesture.
+To cancel the editing process, click on the `Cancel` button.
+
+```{figure} img/tap_setup_screen_options.png
+:alt: Tap Setup Screen (Options Part)
+:width: 100%
+```

_sources/getting_started/gestures_overview.md.txt

@@ -0,0 +1,20 @@
+# Gestures Overview
+
+Once the UX has started & it has connected successfully to the plugin, you will see the following screen:
+
+```{figure} img/gesture_overview_screen.png
+:alt: Binding Overview
+:width: 100%
+```
+
+This page contains an overview of all the gesture you will have set up. \
+Currently, there are no gestures set up, so the application will let you know as above.
+
+The `+` button in the top right corner will allow you to add a new gesture. \
+The Search bar at the top will allow you to search for a specific gesture once you have some set up. \
+The `Save` button in the bottom right corner will allow you to save your current configuration.
+
+Most elements of this application have a tooltip that will appear when you hover over them, \
+so do not hesitate to hover over an element if you are unsure of what it does.
+
+Since there are no gestures set up, let's proceed with adding a new gesture in the next section.

_sources/getting_started/index.rst.txt

@@ -0,0 +1,18 @@
+.. _getting_started:
+
+Getting Started
+===============
+
+Now that you have installed the plugin, Downloaded the Interface & made sure that it connects properly to the plugin, 
+you should be able to start adding new gestures & tweaking them. \
+
+(If you didn't follow the installation guide, it doesn't work & you complain on github, i will find you.)
+
+.. toctree:: 
+    :maxdepth: 1
+
+    running_ux
+    gestures_overview
+    setup_gesture
+    editing_gestures
+    deleting_gestures

_sources/getting_started/running_ux.md.txt

@@ -0,0 +1,7 @@
+# Running the UX
+
+Make sure that you have completed the [](../installation_guide/installation.md) steps before running the UX. \
+The plugin is required to be enabled beforehand for the UX to be able to communicate with it.
+
+Open the Interface Application that you downloaded during [](../installation_guide/installation.md).
+Once that's done and it has connected successfully to the daemon, you may proceed to the next section of the guide.

_sources/getting_started/setup_gesture.md.txt

@@ -0,0 +1,122 @@
+# Setting up a new Gesture
+
+We will now set up a new gesture. Let's start with by clicking the `Setup a new Gesture` button.
+(or the `+` button in the top right corner)
+
+```{figure} img/gesture_selection_screen.png
+:alt: Gesture Selection Screen
+:width: 100%
+```
+
+Here you will see a list of all the gestures that are available to set up. \
+You can search for a specific gesture by typing in the search bar at the top.
+
+## Setting up a simple Tap Gesture
+
+For this example, we will set up the most basic gesture, a single touch **Tap**. \
+A **Tap** will momentarily press a specified Binding.
+
+```{note}
+A Binding is a key, mouse button, or any actions that may be triggered by another plugin.
+```
+
+Click on the **Tap** gesture to proceed.
+
+### Options
+
+```{figure} img/tap_setup_screen_options.png
+:alt: Tap Setup Screen (Options Part)
+:width: 100%
+```
+
+You are now on the first part of the setup screen. Here you can configure the option for the **Tap** gesture. \
+The option in question for this gesture is the number of touches required to trigger the gesture.
+
+```{figure} img/tap_setup_screen_options_dropdown.png
+:alt: Tap Setup Screen (Options Part - Dropdown)
+:align: center
+```
+
+Let's keep this number at `1` for now. \
+Click on the `Next` button to proceed.
+
+### Binding
+
+```{figure} img/tap_setup_screen_binding.png
+:alt: Tap Setup Screen (Binding Part)
+:width: 100%
+```
+
+You are now on the second part of the setup screen. \
+Here you can configure the Binding that will be triggered by the **Tap** gesture.
+
+```{note}
+A Binding is a key, mouse button, or any actions that may be triggered by another plugin.
+```
+
+This interface should be familiar to you if you have used OpenTabletDriver before:
+The large button will open the simple binding editor, 
+while the small button containing `...` will open the advanced binding editor.
+
+For this example, we will use the simple binding editor. \
+Click on the large button to proceed.
+
+```{figure} img/binding_editor_simple.png
+:alt: Simple Binding Editor
+:align: center
+```
+
+Here you can press most keys on your keyboard, or click on the mouse buttons to select them. \
+For this example, let's left click within the white outlined area. \
+Once that's done, the window will close, and the Binding will appear in the Binding Display.
+
+```{figure} img/tap_setup_screen_binding_set.png
+:alt: Tap Setup Screen (Binding Part - Set)
+```
+
+Let's proceed with the final part of the setup by clicking on `Next` again.
+
+### Boundaries & Additional Tweaks
+
+```{figure} img/tap_setup_screen_tweaks.png
+:alt: Tap Setup Screen (Tweaks Part)
+:width: 100%
+```
+
+You are now on the final part of the setup screen. \
+Here you can configure the boundaries and additional tweaks for the **Tap** gesture.
+
+Again, if you have used OpenTabletDriver before, you have probably setup your area in a specific way. \
+Here however, it is slightly different, as a gesture may only be trigerred if it is started within the specified area.
+
+```{warning}
+The boundaries size must be non-zero.
+```
+
+let's keep it at the default values for now and focus on the only available tweak for this gesture: \
+The `Deadline` tweak.
+
+If you hover your cursor over the tweak, you will see a tooltip explaining what it does. \
+In this case, the `Deadline` represents the amount of time within which the gesture must be completed. \
+This include the you put your finger down, until it is lifted up again.
+
+80ms is the default value, but you can change it to your liking.
+
+```{note}
+This value was chosen as it was the average accross all Wacom CTH-xxx & PTH-x51 tablets.
+```
+
+When you are done, click on the `Complete` button to finish the setup.
+
+```{figure} img/gesture_overview_new.png
+:alt: Gesture Overview - New Gesture Added
+:width: 100%
+```
+
+Congratulations! You have successfully set up a new **Tap** gesture.
+
+```{tip}
+You may choose to save your configuration by clicking on the `Save` button in the bottom right corner.
+```
+
+We will now move on to the next step: Editing an existing Gesture.

_sources/index.rst.txt

@@ -0,0 +1,25 @@
+.. Touch Gestures documentation master file, created by
+   sphinx-quickstart on Wed Mar 27 01:25:30 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Touch Gestures's documentation!
+===============================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Installation Guide
+
+   installation_guide/index
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Getting Started
+
+   getting_started/index
+
+.. toctree::
+   :maxdepth: 2
+   :caption: FAQ
+
+   faq/index

_sources/installation_guide/dependencies.md.txt

@@ -0,0 +1,43 @@
+# Dependencies
+
+## Installing Dependencies for the plugin
+
+1. If you haven't downloaded OpenTabletDriver yet, you can follow the "installation" guides [here](https://opentabletdriver.net/). or in video format:
+
+<section class="embed-container">
+    <iframe src="https://www.youtube.com/embed/aFejLY4vKeY?si=7R3k1NKNmZKj2keB" title="YouTube video player" 
+            frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
+            referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+    <p>(Install .NET 6 Desktop Runtime if you plan to use OpenTabletDriver 0.6.4.0)</p>
+</section>
+
+```{warning}
+At the time of writing, The Plugin Dependency Update hasn't been merged into the plugin repository yet.
+You will need to download the latest version of the plugin from [here](https://github.com/Mrcubix/OTD.EnhancedOutputMode/releases/)
+(1.1.2 is the latest version for 0.6.x, 1.1.1 is the latest version for 0.5.x)
+```
+
+2. Open `OpenTabletDriver.UX` and go to `Plugins` > `Open Plugin Manager`,
+3. Look for `Enhanced Output Mode` in the list, select it and click `Install`,
+4. Close the Plugin Manager,
+5. Go to the `Filters` tab and select `Touch Settings`,
+6. Enable it & tick `Toggle Touch` to enable touch input.
+
+```{admonition} For Wacom PTH-x60 Tablet (Paper Edition) Users Only
+:class: warning
+You will need to change the `MaxX` and `MaxY` values in the `Touch Settings` plugin. \
+Follow the steps below to obtain these values.
+```
+
+8. Head to `Tablet` > `Tablet Debugger` and check your touch maxes there.
+9. Move your finger slowly to the bottom right corner of the tablet and check the `X` and `Y` values.
+10. Take note of these values and put them in the `Touch Settings` plugin.
+
+## Installing Dependencies for the UX
+
+1. Install the latest version of [.NET 8 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
+2. You may want to open the terminal and run the following command:
+
+```shell
+dotnet --list-runtimes
+```

_sources/installation_guide/index.rst.txt

@@ -0,0 +1,14 @@
+.. _installation_guide:
+
+Installation Guide
+==================
+
+This guide provides instructions on how to install & setup this this plugin.
+We will first go into which dependencies are required, and then provide instructions on how to install the plugin.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   dependencies
+   installation