Skip to content

WVS

Fork and Configure Turorial · Changes

Page history
Create Fork and Configure Turorial authored by Sopisey Robinson's avatar Sopisey Robinson
Hide whitespace changes
Inline Side-by-side
Fork-and-Configure-Turorial.md 0 → 100644
View page @ 9a8202a5
The goal of this tutorial is to show how you can fork your own personal copy of this project and start deploying builds from it to your own personal Oculus Developer account so that they show up on your Quest headset immediately.
Note that this entire process can be done in the web app, and you will never need to complete this tutorial, you will never need to clone the project locally or use any desktop tools besides your web browser.
The top-level steps are:
1. Create a new Quest App on your Oculus Developer account
2. Fork this project on WVS
3. Configure your new fork to point to your own Quest App
4. Trigger a new build
5. See the app show up on your Quest headset.
## Creating a new Quest App in your Oculus account
1. Go to **Oculus Developer site**
2. From the left-hand panel, go to **My Apps**.
![My_apps](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/My_apps.png)
3. Create a new app by clicking the **Create New App** button on the top right.
![Create_app](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/Create_app.png)
4. Enter the Name of your App and select **Quest (App Lab)**.
![app_lab](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/app_lab.png)
5. Once the app is created, select your app from your list of Apps.
6. In **App Manager**, click on **API** from the left-hand side.
![api](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/api.png)
7. You will need to know the **App ID** and the **App Secret** a little later. Save them or keep the window open
![appID_secret](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/appID_secret.png)
8. From the left-hand panel, click on **Release Channels**. From the list, select the **Alpha** Channel.
![release_alpha](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/release_alpha.png)
9. Once you are in the **Alpha Channel**, click on the **Users** tab and click **Add Users** to add yourself and others to the user list in your Channel.
**Important Note:** Users added to the channel must have an existing Quest account. The email must match the email address they used when creating their Quest Account. Each user added to the channel will continue to get updates to the app on their Quest Headset when a new build is distributed.
![add_user_alpha](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/add_user_alpha.png)
10. Enter the email addresses to invite Quest users to your project.
![add_user_invite](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/add_user_invite.png)
## Forking the project on WVS
Let's get started on creating your own personal copy of the example project.
1. From the **WVS** **Explore** page, click on the example project.
2. The landing page will take you to the project's **Activity** feed. From there, select the project name from the top left.
![project_landing](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/project_landing.png)
3. Now that you're on the project home page, you should see a list of files in the project. In the center of the page, the project title is displayed, to the right of that, click on the small **Fork** button.
![fork](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/fork.png)
4. In the **Fork Project** page, you can enter a name to personalize your project, select the namespace you would like your project to reside in, whether it's your own namespace or in a group you're working in, they will both be accessible to you. The project slug will be the name used in your URL path and often kept the same as the project. Select your visibility level and click the **Fork** button.
![fork_page](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/fork_page.png)
5. Your project is Forked and ready to use!
## Configuring your new fork
Let's get your new project set up to deploy to your Quest!
1. Open up your newly forked project.
2. Go to **Project Settings** from the left-hand nav and click on CI/CD from the expanded list.
![WVSProj_settings](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/WVSProj_settings.png)
3. Go to the **Variables** section and click expand.
![variables](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/variables.png)
4. Click the **Add Variable** button to add your oculus variables.
![add_variables1](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/add_variables.png)
5. Use the variables you grabbed from your Oculus account to set **2** new variables for the following values.
| Key | Value | Protect | Mask |
|-----|-------|---------|------|
| <span dir="">WVSUSR_QUEST_APPID</span> | <span dir="">Oculus App ID</span> | no | yes |
| <span dir="">WVSUSR_QUEST_APPSECRET</span> | Oculus App Secret | no | yes |
**<span dir="">Note</span>**<span dir="">:</span>
* <span dir="">Protected: Only Exposed to protected branches or tags.</span>
* <span dir="">Masked: Hidden in job logs. Must match masking requirements</span>
6. Add the Values from your Oculus Account for the variables above and set your flags according to the list above. Click on the **Add Variable** button.
![add_variables1](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/add_variables1.png)
7. Repeat steps **4-6** for both variables listed.
8. You did it! You should now have **2** Variables set for your project.
![var1](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/var1.png)
<div>
Additional instructions on variables can be found here <https://docs.wvs.io/wiki/flows/Preparing_for_flows#deploy-to-oculus>
</div>## **Trigger a New Build**
Ok, we're almost done, let's trigger a build!
1. In the **WVS** web app, locate your project and select it.
2. In the left-hand nav, find **Flows**, expand the list, and select **Pipelines.**
3. Select the Branch you're working in, if you don't have branches set, leave it on main and select **Run Pipeline.**
4. You're now taken to the pipeline that was triggered, in this page, you can see the progress of each job.
5. You can navigate to **Outputs >> Builds** to see your list of available builds when it is ready. The status of the build will be displayed once the build is complete.
6. if your build status is Green, you're ready to test out your app!
## See the app on your Quest
Let's put on our Quest Headset and locate our new app! But first, let's go through the steps to find the app.
1. Your new app should appear with an App Lab label and the name of the app you chose. If you don't immediately see your app in your list of apps, you may need to search for it. Locate the **Store** and click on it.
![appLab](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/appLab.png)
2. At the Top of the screen, click on the search bar.
![search_app](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/search_app.png)
3. A keyboard should pop up at the bottom, enter the exact name you chose for your app. (e.g. **Ue5VrStarterQuest)** and search. Your result should appear, select to install.
![image](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/image.png)
5\.If you've made edits to the project and have deployed changes, you will see a message on the app that says "**Update Available".** Once you open up your app, you will get a prompt to update.
![update_app](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/update_app.png)
6\. Once you open up your app, you will get a prompt to update. Click on Update now.
![update_app_2](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/update_app_2.png)
7\. You will be returned to the **App Library**, and your app will show **Installing** in the app.
![update_installing](https://wvs.io/wvs-project-examples/UE5-Quest-Starter-Project/-/raw/main/readmeImages/update_installing.png)
Once that finishes up, your app will be updated and ready to go!
\ No newline at end of file