Skip to content

Commit

Permalink
[Fix] Debugpanel & SDK versions (#242)
Browse files Browse the repository at this point in the history
  • Loading branch information
BramVerniest authored Nov 15, 2023
1 parent ad21dc9 commit d75cdf8
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 7 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 26 additions & 7 deletions docs/GraFx-Studio/integration/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
tags:
- studioAPI
---

# GraFx studio integration

GraFx studio is a client side browser application.
Expand Down Expand Up @@ -33,6 +28,16 @@ To integrate GraFx Studio you will make use of the editor SDK. This SDK dynamica

We have [SDK reference documentation](https://chili-publish.github.io/studio-sdk/index.html){target="_blank"} and the [SDK codebase](https://github.com/chili-publish/studio-sdk){target="_blank"} is open sourced.

### SDK Version

Integrating an SDK into your project can be done in two ways: using a **JavaScript link** or a **package manager** like NPM.

Using a JavaScript link connects directly to the **latest hosted version**, ensuring automatic updates and access to new features. However, this method can lead to unexpected changes if the SDK is updated.

Using a package manager like NPM allows you to download and install a **specific SDK version**, offering more control and stability. This approach is beneficial for maintaining consistency, especially in larger projects, but requires manual updates to access new features or security improvements.

The choice between these methods depends on your project's needs for latest updates versus stability and the team's ability to manage SDK updates.

### Demo integrations

To make life easier, we have created a couple of [demo integrations](https://github.com/chili-publish/studio-sdk-integration-examples){target="_blank"}, so you don't have to start from scratch.
Expand All @@ -41,7 +46,7 @@ You can use this script in your HTML to always get the latest SDK version:


``` js
<script src="https://cdnepgrafxstudioprd.azureedge.net/sdk/latest/main.js"></script>
<script src="https://studio-cdn.chiligrafx.com/sdk/latest/main.js"></script>
```

Or you can use NPM to install a specific SDK version, with the following command:
Expand All @@ -56,7 +61,21 @@ You should subscribe to specific events instead of the global stateChanged event

### Debug panel

On the top left of the editor canvas there is a button to open the debug panel. This panel shows a log of all interactions with the editor engine. This can help while building your integration.
The shortcut will open the debug panel.

Mac: ⌥ (option) + 🌐 fn + F1

Windows: Alt + F1

![Debug panel](debugpanel.png)

This panel shows a log of all interactions with the SDK. This can help while building your integration.

There is also an FPS graph, to display the performance of the Editor.

The "Info" tab shows versions of the Engine and SDK.

A triggers tab holds several buttons to trigger events for the template.

### GraFx Connector

Expand Down

0 comments on commit d75cdf8

Please sign in to comment.