Skip to main content

Deploy the App

Let's deploy the app we've created so far. You should deploy your app to apply the haptics to your game.

Before deploying, make sure to save your project.

note

Save and Deploy is not the same thing! Changes won't be reflected in the game until you deploy the app!

Let's Deploy​

To apply the haptic app to your game, two things need to be done first:

  • Get the App ID and API Key
  • Deploy the app

Create API Key​

App ID and API Key are required for accessing this app. You will use these when you link the app to your game. The App ID is automatically generated when you create the app. However, you need to manually generate the API Key.

Frame 58.png

  1. Move to the "API Key" tab. You can see that there is no API Key in the list.
  2. Press the "New" button. Then, a pop-up window will appear.
  3. Press the "OK" button to generate an API Key.

Frame 63.png

After, you can see that the new API Key was generated in the list.

You can see that the new API Key was generated in the list. You can also delete the API Key by pressing the "Delete" button that appears when you hover over the item.

note

API Keys should never be shared publicly! If you accidentally expose it, delete it immediately from the Portal.

Deploy​

Frame 59.png

You'll notice that the "Deploy Now" button is always present at the top right. Let's press it.

Frame 60.png

Frame 61.png

  1. You can change the Deploy Version name if needed. It's also good practice to briefly describe the deployment, but leaving it as is also works fine.
  2. Press the "OK" button to deploy.
  3. A success window will appear. Press "OK" to close it.

Untitled

Afterward, when you navigate to the "Deploys" tab, you'll see that the deployment history list has been updated with the record of the deployment you just made.

Settings​

Frame 62.png

When you're ready to apply haptics to your game, you should link the bHaptics App to your game.

  • Browse the App ID and API Key for linking this app to your game.
  • You can also invite users to collaborate. Press "New" to invite users, granting them access to this application.

You're ready to apply haptic in your game! The final step is installing the SDK plugin into you game project and linking the game and the app using the App ID and API key.

Please refer to the SDK section to link this app and your game.

Update the App​

If you make any changes to the app(such as changing the pattern or renaming the event), you'll need to deploy again.

Change the Pattern​

When editing the haptic patterns for events you have created, you do not need to modify or rebuild the game! Our system automatically merges the changes onto a separate build. That's one of the great advantages of our bHaptics ecosystem.

Change the Event​

However, if you are adding more events or renaming the event, you'll need to rebuild the game and push it again.

Deployment History​

Slide 16_9 - 8.png

In the "Deploys" tab, you can view the Deployment History. Here, you can check the version of the deployment, the deployment date, the creator, the number of events, and the name of the deployment.

Frame 72.png

When hovering over an item, you'll see the following options:

  • Clone: Saves all the haptic patterns included in the deployment to the Designer. 해당 배포판에 있는 모든 패턴들을 디자이너에 저장합니다.
  • Detail: View the details of the selected deployment. 해당 배포판의 세부 정보를 확인합니다.
  • *Rollback: Reverts the app to a previous deployment. This option appears only for deployments that are not the most recent.

Clone​

Saves all the haptic patterns included in the deployment to the Designer.

Detail​

Untitled

It shows you the category, events, and name of the selected deployment.

Additionally, you can click the "Recover" button at the bottom to load this deployment. When you recover, all the content you're currently working on in the Event tab will match this deployment.

Rollback​

Reverts the app to a previous version. Technically, it redeploys the content of the selected deployment as a new deployment. After rolling back, you'll see a new item at the top of the deployment list.

Even after rolling back, the content you're working on in the Event tab won't change. If you want to revert the content in the Event tab as well, you can use the Recover feature. Simply go into the Detail of the deployment created by the rollback, and apply the Recover option.

Now that we've created a haptic app and gone through the process of applying it to the game, let's explore some best practices for managing the app.