Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Launch Page docs #567

Merged
merged 3 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .tx/config
Original file line number Diff line number Diff line change
Expand Up @@ -1625,6 +1625,13 @@ type = GITHUBMARKDOWN
minimum_perc = 0
resource_name = content/en/user-manual/editor/keyboard-shortcuts.md

[o:playcanvas:p:playcanvas-developer-site:r:user-manual-editor-launch-page]
file_filter = i18n/<lang>/docusaurus-plugin-content-docs/current/user-manual/editor/launch-page.md
source_file = docs/user-manual/editor/launch-page.md
type = GITHUBMARKDOWN
minimum_perc = 0
resource_name = content/en/user-manual/editor/launch-page.md

[o:playcanvas:p:playcanvas-developer-site:r:user-manual-editor-loading-screen]
file_filter = i18n/<lang>/docusaurus-plugin-content-docs/current/user-manual/editor/loading-screen.md
source_file = docs/user-manual/editor/loading-screen.md
Expand Down
2 changes: 0 additions & 2 deletions docs/tutorials/collision-and-triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,4 @@ And that's all there is to handling Collisions and Triggers in PlayCanvas.
[6]: /images/tutorials/collision/ground_setup.png
[7]: /images/tutorials/collision/trigger_setup.jpg
[8]: https://api.playcanvas.com/classes/Engine.Entity.html

/classes/Engine.Entity.html
[9]: /images/tutorials/collision/box_setup.png
38 changes: 38 additions & 0 deletions docs/user-manual/editor/launch-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Launch Page
sidebar_position: 4.5
---

The Editor's Viewport is where you visually construct your application. From there, you can press the Launch button to open the Launch Page and actually _run_ your application.

![Launch Button][1]

## Working with the Launch Page

When you activate the Launch Page, it will open in a new tab. It is perfectly valid to switch back and forth between the Editor and the Launch Page. However, if you have a large screen or even a multi-monitor setup, consider tearing off the Launch Page tab and placing it side by side with the Editor.

![Launch Page Side by Side][2]

This can make it easier and quicker to switch between the two.

## Real-Time Updates

A key feature of the Launch Page is that it maintains a real-time connection (or live-link) to the Editor. This means that any change made in the Editor will be immediately reflected in the Launch Page.

![Launch Page Live Link][3]

And if any other users (with write permission) are present in the Editor with you, their edits can update your Launch Page as well.

## Running on Other Devices

Sometimes it can be useful to run the Launch Page on another device. For example, you might wish to test your application on a mobile device. To do this, ensure you are logged in to your PlayCanvas account on that device. Then, simply visit the Launch Page URL in your device's browser.

:::tip

Chrome can dynamically generate a QR code for any page. From the Launch Page on your desktop, open Chrome's main menu and select `Save and share` > `Create QR Code`. Then, scan the QR code on your mobile device to instantly visit the Launch Page.

:::

[1]: /images/user-manual/editor/launch-page/launch-button.png
[2]: /images/user-manual/editor/launch-page/launch-page-side-by-side.png
[3]: /images/user-manual/editor/launch-page/launch-page-live-link.gif
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Launch Page
sidebar_position: 4.5
---

The Editor's Viewport is where you visually construct your application. From there, you can press the Launch button to open the Launch Page and actually _run_ your application.

![Launch Button][1]

## Working with the Launch Page

When you activate the Launch Page, it will open in a new tab. It is perfectly valid to switch back and forth between the Editor and the Launch Page. However, if you have a large screen or even a multi-monitor setup, consider tearing off the Launch Page tab and placing it side by side with the Editor.

![Launch Page Side by Side][2]

This can make it easier and quicker to switch between the two.

## Real-Time Updates

A key feature of the Launch Page is that it maintains a real-time connection (or live-link) to the Editor. This means that any change made in the Editor will be immediately reflected in the Launch Page.

![Launch Page Live Link][3]

And if any other users (with write permission) are present in the Editor with you, their edits can update your Launch Page as well.

## Running on Other Devices

Sometimes it can be useful to run the Launch Page on another device. For example, you might wish to test your application on a mobile device. To do this, ensure you are logged in to your PlayCanvas account on that device. Then, simply visit the Launch Page URL in your device's browser.

:::tip

Chrome can dynamically generate a QR code for any page. From the Launch Page on your desktop, open Chrome's main menu and select `Save and share` > `Create QR Code`. Then, scan the QR code on your mobile device to instantly visit the Launch Page.

:::

[1]: /images/user-manual/editor/launch-page/launch-button.png
[2]: /images/user-manual/editor/launch-page/launch-page-side-by-side.png
[3]: /images/user-manual/editor/launch-page/launch-page-live-link.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading