Skip to content

Commit

Permalink
Updated Installation & FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrcubix committed Apr 2, 2024
1 parent a3874bc commit 8268844
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 17 deletions.
4 changes: 3 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
]

myst_enable_extensions = [
"colon_fence"
"colon_fence",
"attrs_block",
"attrs_inline"
]

templates_path = ['_templates']
Expand Down
7 changes: 4 additions & 3 deletions faq/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
<br>

- Q: Can i use this without a touch tablet?
- A: Not currently, however, i do think that being able to trigger single-touch festures with just a pen would be a good idea
(Soft Keys for example).
- 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: Not currently, but an in-interface dropdown will be a neccessity for proper support of OpenTabletDriver 0.6.x & later.
- 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>

Expand Down
6 changes: 5 additions & 1 deletion faq/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

- 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 a line that says `[Touch Gestures:Info] Initialized` in OpenTabletDriver's console. \
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>
Expand Down
33 changes: 21 additions & 12 deletions installation_guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,35 @@ Now that you have installed and setup the dependencies, you can now proceed to i
There are two ways to install the plugin, either from the Plugin Manager or from the repository. \
I do recommend installing it from the Plugin Manager as it is easy to use & likely to be the latest stable version.

(from-manager)=
### From the Plugin Manager

1. Open `OpenTabletDriver.UX` and go to `Plugins` > `Open Plugin Manager`,
2. Look for `Touch Gestures` in the list, select it and click `Install`,
2. Look for `Touch Gestures Installer` in the list, select it and click `Install`,
3. Close the Plugin Manager,
4. Go to the `Filters` tab and select `Touch Gestures`,
5. Enable it.
6. Got to the `Tools` tab and select `Touch Gestures Daemon`,
7. Enable it.
4. Go to the `Tools` tab and select `Touch Gestures Installer`,
6. Enable it then click Apply.
7. Restart OpenTabletDriver, then proceed with [](#plugin-setup).

(from-repo)=
### From the Repository

1. Download `Touch-Gestures.dll` from the [Latest Release](https://github.com/Mrcubix/Touch-Gestures/releases/latest)
1. Download `Touch-Gestures.Installer.dll` from the [Latest Release](https://github.com/Mrcubix/Touch-Gestures/releases/latest)
2. Open `OpenTabletDriver.UX` and go to `Plugins` > `Open Plugin Manager`,
3. Go to `File` > `Install Plugin` and select the downloaded `Touch-Gestures.dll`,
4. Close the Plugin Manager
5. Go to the `Filters` tab and select `Touch Gestures`,
6. Enable it.
7. Got to the `Tools` tab and select `Touch Gestures Daemon`,
8. Enable it.
3. Go to `File` > `Install Plugin` and select the downloaded `Touch-Gestures.Installer.dll`,
4. Close the Plugin Manager,
5. Go to the `Tools` tab and select `Touch Gestures Installer`,
6. Enable it then click Apply.
7. Restart OpenTabletDriver, then proceed with [](#plugin-setup).

(plugin-setup)=
## Setting Up The Plugin

4. Go to the `Filters` tab and select `Touch Gestures`,
5. Enable it.
6. Got to the `Tools` tab and select `Touch Gestures Daemon`,
7. Enable it.
8. Click Save / Apply, once that's done you can proceed with downloading the interface.

## Downloading the Interface

Expand Down

0 comments on commit 8268844

Please sign in to comment.