Skip to content

Commit 7906347

Browse files
committed
Updated install instructions
with screenshots and updated graphics for the latest version of the driver and steamVR
1 parent b7beb5f commit 7906347

25 files changed

Lines changed: 41 additions & 23 deletions

Assets/Readme.md

Lines changed: 41 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Get to Know Your Device
22
Here are descriptions of the different buttons and inputs available with Logitech VR Ink. They will be referenced throughout this guide as well as in the design guidelines, code examples and in other parts of the SDK.
33

4-
![Pairing the VR Ink](../Documentation/Images/ButtonLayout.png)
4+
[<img src="../Documentation/Images/ButtonLayout.png" width="600" alt="VR Ink controls">]()
55

66
| <div style="width:120px">Control</div> | Description |
77
|----|---------------|
@@ -17,40 +17,58 @@ Here are descriptions of the different buttons and inputs available with Logitec
1717
To ensure VR Ink works in applications and appears correctly in the SteamVR shell and status window, an initial installation is required.
1818

1919
## 1. Install the Driver
20-
1. Download the latest [logitech VR Ink Driver](https://store.steampowered.com/app/1068300/Logitech_VR_Ink_Driver/) from the **Steam Store**.
21-
2. After successful install, **make sure your HMD is connected** and turned on, then **restart SteamVR**.
22-
3. Make sure it's **not in Safe mode**, as the driver won't be loaded.
23-
4. Then **pair your VR Ink** following the steps described below.
20+
1. Download the latest [logitech VR Ink Driver](https://store.steampowered.com/app/1068300/Logitech_VR_Ink_Driver/) from the **Steam Store**.<br>
21+
[<img src="../Documentation/Images/SteamVR/steamstore_page_small.png" width="500" >](../Documentation/Images/SteamVR/steamstore_page_small.png)<br><br>
22+
2. After successful install the SteamVR status window should look like the one below: you'll note an additional icon (greyed out) for the Logitech VR Ink driver. <br>
23+
[<img src="../Documentation/Images/SteamVR/steamvr_dash_after_install.png">]()<br><br>
24+
Some verifications before you move on:
25+
* Make sure your **HMD is connected** and turned on.
26+
* Verify that SteamVR is **NOT in Safe mode**, as the driver won't be loaded, if that is the case **restart SteamVR**.<br><br>
27+
3. Then **pair your VR Ink** following the steps described below.
2428

2529

30+
<br>
31+
<br>
2632

2733
## 2. Pairing VR Ink
28-
1. If you already have two controllers paired and connected, **first turn OFF the one you want to replace** the VR Ink with (ex: the right one if you're right-handed pen user)
29-
2. turn on VR Ink by pressing the system button for about a second. The status LED should appear blue if it is not currently paired to a system.
30-
3. In the SteamVR status window, right click on (any) controller icon and select **Pair Controller**.<br>
31-
![SteamVR dashboard](../Documentation/Images/SteamVR/steamvr_dash_pair_controller.png)
32-
4. Click on the button **"I want to pair a different type of controller ..."**
33-
34-
5. Click on the **Logitech VR Ink** section (available from SteamVR 1.9 version) and follow the instructions.
35-
![SteamVR dashboard](../Documentation/Images/SteamVR/steamvr_pair_select.png)
36-
6. Press (and hold) both the **MENU** and **SYSTEM** buttons on VR Ink for a few seconds until the status LED starts blinking blue.
37-
![SteamVR dashboard](../Documentation/Images/SteamVR/steamvr_pair_vrink.png)
38-
39-
7. When VR Ink is successfully paired, the LED will appear as a **solid green**.
40-
8. You should also see updated VR Ink icons in SteamVR status window. You'll note now that both the icons for VR Ink stylus are active.
34+
1. If you already have two controllers paired and connected, **first turn OFF the one you want to replace** the VR Ink with (ex: the right one if you're right-handed pen user)<br>
35+
[<img src="../Documentation/Images/SteamVR/steamvr_dash_off_before_pair.png">]()
36+
37+
2. In the SteamVR status window, right click on (any) controller icon and select **Pair Controller**.<br>
38+
39+
3. Click on the button **"I want to pair a different type of controller ..."**
40+
41+
4. Click on the **Logitech VR Ink** section (instructions available starting from SteamVR 1.9 version) and follow the instructions. <br>
42+
43+
5. Press (and hold) both the **MENU** and **SYSTEM** buttons on VR Ink for a few seconds until the status LED on the stylus starts blinking blue.<br>
44+
[<img src="../Documentation/Images/SteamVR/steamvr_pair_vrink.png" width="500" alt="Pair: select controller">]()
45+
46+
6. When VR Ink is successfully paired, the LED will appear as a **solid green**, click **Done**.<br>
47+
[<img src="../Documentation/Images/SteamVR/steamvr_pair_vrink_success.png" width="500" alt="Pair: select controller">]()
48+
49+
7. You should also see a new stylus icon in SteamVR status window alongside the VR Ink Driver one. You'll note now that both the icons for VR Ink stylus are active.
4150
<br>
42-
![Pairing the Ink](../Documentation/Images/SteamVR/steamvr_dash_ok.png)
51+
[<img src="../Documentation/Images/SteamVR/steamvr_dash_ok_full.png" alt="SteamVR status all good">]()
52+
53+
8. When it first start, the VR Ink Driver will suggest to opt in for some analytics: <br>**Rest reassured**: We won't be able to see what you draw or write, but only measure the amount of time that the stylus is being used. This will allow us to **improve the HW and the SW experience** in the future !<br>
54+
[<img src="../Documentation/Images/Driver/DriverAnalytics.png" alt="Driver Analytics opt in" width="500">]()
4355

44-
9. Now, If you wear the HMD you should see the VR Ink model in the SteamVR Shell.
56+
<br>
57+
<br>
4558

4659
## 3. Using VR Ink
47-
After your VR Ink is set up, we highly recommend that you check out our Demo App or dive into the Unity, Unreal or Native integration guides.
60+
* Now, If you wear the HMD you should see the VR Ink model in the SteamVR Shell: try to move it !
61+
* You can bring up the **Logitech VR Ink settings UI** either from clicking on its icon in the **taskbar** or from the windows **tray**:<br>[<img src="../Documentation/Images/Driver/task_bar_icon.png" width="167" alt="Task Bar">]() [<img src="../Documentation/Images/Driver/vrink driver tray.png" width="214" alt="Windows tray">]()<br>
62+
* The UI allows you to **verify the status** of your stylus as well as **select specific pressure sensitivity** for the PRIMARY, TIP and GRIP force sensing buttons.<br>
63+
[<img src="../Documentation/Images/Driver/driver_ui.png" width="500" alt="Driver UI">]()
4864

65+
* After your VR Ink is set up, we highly recommend that you check out our Demo App:<br>
4966
[<img src="../Documentation/Images/LandingPage/DemoExperience.png" width="214" alt="Demo Experience">](../Documentation/DemoExperience)
67+
68+
* or have a look at our integration tutorials:<br>
5069
[<img src="../Documentation/Images/LandingPage/UnityIntegration.png" width="214" alt="Unity Integration">](./UnitySampleProjects)
5170
[<img src="../Documentation/Images/LandingPage/UnrealIntegration.png" width="214" alt="Unreal Integration">](./UnrealSampleProject)
5271
[<img src="../Documentation/Images/LandingPage/NativeIntegration.png" width="214" alt="Native Integration">](./NativeSampleProject)
5372

54-
If you want to know more about the features of the VR Ink driver, click on Driver Icon here below.
55-
<br>
73+
* If you want to know more about the features of the VR Ink driver, click on Driver Icon here below:<br>
5674
[<img src="../Documentation/Images/LandingPage/Driver.png" width="214" alt="Demo Experience">](../Documentation/Driver)
31.2 KB
Loading
626 KB
Loading
189 KB
Loading
10.3 KB
Loading
13.4 KB
Loading
13.9 KB
Loading
10.7 KB
Loading
8.88 KB
Loading
10.9 KB
Loading

0 commit comments

Comments
 (0)