You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+30-12Lines changed: 30 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -122,7 +122,13 @@ The testing process for Hubs is mostly a manual one. You need to test your chang
122
122
123
123
The Hubs team has a more in-depth testing and release process internally, but we don't have any additional testing process for external contributors at this time.
124
124
125
-
### 5. High Level Project Organization
125
+
126
+
### 5. Modifying The 2-D Sprite Graphics
127
+
128
+
To update the 2-D sprite graphics, you must (manually) install [ImageMagick](https://imagemagick.org/script/download.php) to your command line. See `doc/spritesheet-generation.md` for further details
129
+
130
+
131
+
### 6. High Level Project Organization
126
132
127
133
```
128
134
hubs/
@@ -153,11 +159,11 @@ hubs/
153
159
scene.html <- Scene Page html template
154
160
scene.js <- Scene Page js entry point
155
161
```
156
-
### 6. Testing on an HMD
162
+
### 7. Testing on an HMD
157
163
158
164
The simplest way to test on an HMD is to use `npm run dev` from Step 2 above while having 8080 port traffic on your device point to you local dev instance's port 8080. In order to do that, you'll need to do a few things that will vary per device.
159
165
160
-
### Oculus Quest
166
+
####Oculus Quest
161
167
162
168
These steps are what's necessary to enable development on your device
163
169
@@ -174,25 +180,37 @@ These steps are what's necessary to enable development on your device
174
180
`adb devices -l`
175
181
Lists all connected devices. The -l flag will list device specific details, one of which should be: `model:Quest`
176
182
177
-
`adb -s model:Quest reverse tcp:8080 tcp:8080`
178
-
`adb reverse tcp:8080 tcp:8080`
183
+
`adb -s model:Quest reverse tcp:8080 tcp:8080`
184
+
`adb reverse tcp:8080 tcp:8080`
179
185
This command routes all port 8080 requests from the Quest device to port 8080 on your local web server. The first one is if you want to do things wirelessly, while the second is a quicker (albeit tethered) solution that is less prone to the error below.
180
186
181
187
If you encounter the following error:
182
188
adb: error: more than one device/emulator
183
189
184
-
Try killing and restarting adb with the following commands:
185
-
`adb kill-server`
186
-
`adb start-server`
187
-
Then retry the reverse command above again
190
+
Try killing adb with the following commands:
191
+
`adb kill-server`
192
+
Then try the reverse command above again (the server will be restarted).
188
193
189
-
3. Open a browser on the Quest device and test.
190
-
Go to the following url: `https://localhost:8080` in the Oculus broswer or Firefox Reality browser
194
+
3. Open a browser on the Quest device and test. Either
195
+
`adb shell am start -a android.intent.action.VIEW -d 'https://localhost:8080'`
196
+
or launch the Oculus browser or Firefox Reality browser and go to the following url: `https://localhost:8080`
191
197
192
198
> Note the client runs over https with a self-signed SSL certificate. You'll be presented with a warning the first time you open the page. You can accept the SSL certificate warning and continue onto the site.
193
199
194
200
4. You should see the Hubs index page, the same one you see in a browser on your development machine.
195
201
196
-
### Other Devices
202
+
You may find the tool [scrcpy](https://github.com/Genymobile/scrcpy) useful to display the screen of your headset on your development computer. It doesn't require the headset user to accept, so it's less hassle than casting to a phone or tablet, in some circumstances.
203
+
204
+
#### Pico G2 / Neo 2
205
+
206
+
Follow the directions for the Quest, except
207
+
208
+
* Setup the Pico device for development. (You may need to press the Confirm and Volume Down buttons on the headset simultaneously to enter the system settings.)
0 commit comments