# Breakroom Web Browser

{% embed url="<https://youtu.be/SHCteM7Nn1g?feature=shared>" %}

## Overview

The Breakroom Web Browser allows users to access and interact with web-based content anywhere within your world. Object Owners and users with appropriate [World-](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/world-level-user-permissions) or [Region-level](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/region-level-user-permissions) permissions can also configure access options and add a splash screen that will be displayed when the web browser is not in use.

In your Inventory, you'll see the Breakroom Web Browser represented by this icon: <img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FxDeRoTYCIWH6F5gCi3yL%2FToolkit_Web_Browser.png?alt=media&#x26;token=8d78b949-35e7-4212-8e2c-2f70fe6f1516" alt="" data-size="line">

For help installing the Breakroom Video Player, please review our information on using the [Region Editor](https://docs.breakroom.tech/creating-custom-experiences/using-the-region-editor).

{% hint style="warning" %}
In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to [install these components manually](https://docs.breakroom.tech/advanced-tutorials/uploading-your-own-region/installing-the-conference-system-components) prior to setting up this object.
{% endhint %}

{% hint style="warning" %}
The Breakroom Web Browser will not play MP4 or HLS videos. Please use the [Breakroom Video Player](https://docs.breakroom.tech/creating-custom-experiences/exploring-the-breakroom-toolkit/breakroom-video-player) to share media using these formats.
{% endhint %}

## Breakroom Web Browser user controls

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FVDlMbf2CDxy6Gg9cNuJ6%2FToolkit_Web_001.png?alt=media&#x26;token=9f7adf93-3ca8-4192-9280-cfb8d6e81cde" alt="" width="563"><figcaption><p>Pictured: The Breakroom Web Browser user control bar.</p></figcaption></figure>

Users can control any Breakroom Web Browser using the buttons located in the bottom control bar. Webpages are displayed on a per-user basis, not streamed openly to the Region as a whole.

<table><thead><tr><th width="239">Control bar component</th><th>Function</th></tr></thead><tbody><tr><td>Home</td><td>Takes the user back to the web browser's default URL.</td></tr><tr><td>Forward and back arrows</td><td>Allow users to navigate forward and backward within a website.</td></tr><tr><td>External open</td><td>Opens the default URL in the user's own web browser.</td></tr><tr><td>Zoom In / Zoom Out</td><td>Allows the user to zoom in on the panel and away again.</td></tr><tr><td>Settings</td><td>Only available to Object Owners and users with appropriate permissions.</td></tr></tbody></table>

## Setting up the Breakroom Web Browser

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FATwJDkQ6jDvSTDu54ZyC%2FToolkit_Web_002.png?alt=media&#x26;token=8e69155d-64e8-452e-babc-d0070241377c" alt="" width="563"><figcaption><p>Highlighted: The location of the Breakroom Web Browser gear icon.</p></figcaption></figure>

The Breakroom Web Browser control panel is only accessible to the Object Owner and users with appropriate [World-](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/world-level-user-permissions) or [Region-level](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/region-level-user-permissions) permissions. To access it, click on the **gear icon** in the bottom control bar.

### Adding a splash screen image

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FWssSg2sPtS9gob6TLInp%2FToolkit_Web_003.png?alt=media&#x26;token=acb045ef-19ba-4152-95a1-42a97f685f45" alt="" width="375"><figcaption><p>Pictured: The Breakroom Web Browser settings.</p></figcaption></figure>

Splash screen image settings are the very first thing you'll see in the Breakroom Web Browser control panel. You can either choose a splash image from your Media Library, or upload a new splash image from your computer.

To set a splash screen for your web browser, follow these steps:

1. Locate the Breakroom Web Browser object you want to edit.
2. Click on the **gear icon** to open the Breakroom Web Browser control panel.
   1. To choose an image you've already uploaded to Breakroom, click the **Image Library button**. This will open the image picker. Click on the **image** you want to use.
   2. To upload a new splash image from your computer, or click the **Upload New Image button**. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the **Open button**.
3. Your selected image will display in the preview window. Make sure everything looks good, and then click the **Save and Close button**.

### Entering a webpage URL

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FHbyi13Gs97Dl2tmRPB7N%2FToolkit_Web_004.png?alt=media&#x26;token=ca9dfc7a-795b-491a-aa71-92506b226a3b" alt="" width="370"><figcaption><p>Pictured: The webpage URL and web browser options in the Breakroom Web Browser control panel.</p></figcaption></figure>

To enter a webpage URL, follow these steps:

1. Locate the Breakroom Web Browser object you want to edit.
2. Click on the **gear icon** to open the Breakroom Web Browser control panel.
3. Paste your URL into the **Webpage URL field**.
4. Click the **Save and Close button**.

### Web browser options

The Breakroom Web Browser control panel also allows you to customize the way users can interact with your content.

To edit the web browser options, follow these steps:

1. Locate the Breakroom Web Browser object you want to edit.
2. Click on the **gear icon** to open the Breakroom Web Browser control panel.
3. Click the **ON or OFF button** located next to each web browser option.
4. Click the **Save and Close button**.

<table><thead><tr><th width="220">Web browser option</th><th>Function</th></tr></thead><tbody><tr><td>Allow forward/back</td><td>If set to ON, web navigation buttons will be displayed in the bottom control bar.</td></tr><tr><td>Allow external viewing</td><td>If set to ON, a button will appear in the bottom control bar allowing users to open the webpage in an external browser.</td></tr><tr><td>Post FX</td><td>If set to ON, will turn off various graphics settings within the web browser <a href="#editing-the-breakroom-web-browser-collider-zone">collider zone</a> that could distort the screen.</td></tr></tbody></table>

### Editing the Breakroom Web Browser collider zone

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FRzi3N1DElB3vlyae44QV%2FToolkit_Video_006.png?alt=media&#x26;token=6f52f743-5641-434d-bfce-7236f91d1624" alt=""><figcaption><p>Pictured: The Region Editor, with a Breakroom Video Player object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Video Player object. This information also applies to Breakroom Web Browsers.</p></figcaption></figure>

Several website display options are triggered when an avatar enters the Breakroom Web Browser collider zone. The size and position of this collider zone can be customized using the Region Editor.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help[ installing](https://docs.breakroom.tech/creating-custom-experiences/using-the-region-editor) and [positioning](https://docs.breakroom.tech/creating-custom-experiences/using-the-region-editor/editing-and-moving-objects) virtual objects, or editing the [RoomFurniture component](https://docs.breakroom.tech/running-your-event/customizing-the-conference-system-components/the-roomfurniture-component).

To edit the Breakroom Web Browser collider zone, follow these steps:

1. Open the Region Editor by clicking the **Edit Region button** at the bottom of your screen.
2. Locate the Breakroom Web Browser object you want to edit. Click on it to highlight it in the **Objects window**.
3. In the Objects window, click the **> arrow** to the left of the Breakroom Web Browser object to expand it. Then click on the **Collider component.**
4. Using the [Region Editor tools](https://docs.breakroom.tech/creating-custom-experiences/using-the-region-editor/editing-and-moving-objects) or the [Transform component](https://docs.breakroom.tech/using-the-region-editor/editing-and-moving-objects#editing-the-transform-component), move, rotate, and resize the collider to meet your specifications.
5. When you are satisfied, click the **Save button** to store your changes.