About WorkAdventure maps

Opening a website when walking on the map

On your map, you can define special zones. When a player will pass over these zones, a website will open (as an iframe on the right side of the screen)

In order to create a zone that opens websites:

You must create a specific layer.
In layer properties, you MUST add a "openWebsite" property (of type "string"). The value of the property is the URL of the website to open (the URL must start with "https://")

A website can explicitly forbid another website from loading it in an iFrame using the X-Frame-Options HTTP header.

Integrating a Youtube video

A common use case is to use openWebsite to open a Youtube video.

The global Youtube page cannot be embedded into an iFrame (it has the X-Frame-Options HTTP header).

To embed a Youtube video, be sure to use the "embed" link. You can get this link be clicking "Share > Embed" in Youtube.

Find the URL of your video in the "embed Video" HTML snippet on Youtube

Put this URL in the "openWebsite" property

Triggering of the "open website" action

By default, the iFrame will open when a user enters the zone defined on the map.

It is however possible to trigger the iFrame only on user action. You can do this with the openWebsiteTrigger property.

If you set openWebsiteTrigger: onaction, when the user walks on the layer, an alert message will be displayed at the bottom of the screen:

The iFrame will only open if the user clicks Space

If you set openWebsiteTriggerMessage: your message action you can edit alert message displayed. If is not defined, the default message displayed is 'Press on SPACE to open the web site'.

Setting the iFrame "allow" attribute

By default, iFrames have limited rights in browsers. For instance, they cannot put their content in fullscreen, they cannot start your webcam, etc...

If you want to grant additional access rights to your iFrame, you should use the openWebsitePolicy property. The value of this property will be directly used for the allow atttribute of your iFrame.

For instance, if you want an iFrame to be able to go in fullscreen, you will use the property openWebsitePolicy: fullscreen

The generated iFrame will have the allow attribute set to: `<iframe allow="fullscreen">`

Opening a Jitsi meet when walking on the map

On your map, you can define special zones (meeting rooms) that will trigger the opening of a Jitsi meet. When a player will pass over these zones, a Jitsi meet will open (as an iframe on the right side of the screen)

In order to create Jitsi meet zones:

You must create a specific layer.
In layer properties, you MUST add a "jitsiRoom" property (of type "string"). The value of the property is the name of the room in Jitsi. Note: the name of the room will be "slugified" and prepended with the name of the instance of the map (so that different instances of the map have different rooms)

Triggering of the "Jitsi meet" action

By default, Jitsi meet will open when a user enters the zone defined on the map.

It is however possible to trigger Jitsi only on user action. You can do this with the jitsiTrigger property.

If you set jitsiTrigger: onaction, when the user walks on the layer, an alert message will be displayed at the bottom of the screen:

Jitsi meet will only open if the user clicks Space

If you set jitsiTriggerMessage: your message action you can edit alert message displayed. If is not defined, the default message displayed is 'Press on SPACE to enter in jitsi meet room'.

Customizing your "Jitsi meet"

Your Jitsi meet experience can be customized using Jitsi specific config options. The jitsiConfig and jitsiInterfaceConfig properties can be used on the Jitsi layer to change the way Jitsi looks and behaves. Those 2 properties are accepting a JSON string.

For instance, use jitsiConfig: { "startWithAudioMuted": true } to automatically mute the microphone when someone enters a room. Or use jitsiInterfaceConfig: { "DEFAULT_BACKGROUND": "#77ee77" } to change the background color of Jitsi.

The jitsiConfig property will override the Jitsi config.js file

The jitsiInterfaceConfig property will override the Jitsi interface_config.js file

If your customizations are not working:

First, check that the JSON you are entering is valid. Take a look at the console in your browser. If the JSON string is invalid, you should see a warning.
Then, check that the JSON you are using is matching the version of Jitsi used.

Granting moderator controls in Jitsi

Moderator controls are linked to member tags. You need a pro account to edit member tags.

You can grant moderator rights to some of your members. Jitsi moderators can:

Publish a Jitsi meeting on Youtube Live (you will need a Youtube Live account)
Record a meeting to Dropbox (you will need a Dropbox account)
Mute someone
Mute everybody expect one speaker
Kick users out of the meeting

In order to grant moderator rights to a given user, you can add a jitsiRoomAdminTag property to your Jitsi layer. For instance, if you write a property:

jitsiRoomAdminTag: speaker

then, any of your member with the speaker tag will be automatically granted moderator rights over this Jitsi instance.

You can read more about managing member tags in the admin documentation.

Using another Jitsi server

WorkAdventure usually comes with a default Jitsi meet installation. If you are using the online version at workadventu.re, we are handling a Jitsi meet cluster for you. If you are running the self-hosted version of WorkAdventure, the administrator probably set up a Jitsi meet instance too.

You have the possibility, in your map, to override the Jitsi meet instance that will be used by default. This can be useful for regulatory reasons. Maybe your company wants to keep control on the video streams and therefore, wants to self-host a Jitsi instance? Or maybe you want to use a very special configuration or very special version of Jitsi?

Use the jitsiUrl property to in the Jitsi layer to specify the Jitsi instance that should be used. Beware, jitsiUrl takes in parameter a domain name, without the protocol. So your should use:
jitsiUrl: meet.jit.si
and not
jitsiUrl: https://meet.jit.si

When you use jitsiUrl, the targeted Jitsi instance must be public. You cannot use moderation features or the JWT tokens authentication with maps configured using the jitsiUrl property.

Making a "silent" zone

On your map, you can define special silent zones where nobody is allowed to talk. In these zones, users will not speak to each others, even if they are next to each others.

In order to create a silent zone:

You must create a specific layer.
In layer properties, you MUST add a boolean "silent" property. If the silent property is checked, the users are entering the silent zone when they walk on any tile of the layer.

Playing sounds or background music

Your map can define special zones where a sound or background music will automatically be played.

In order to create a zone that triggers sounds/music:

You must create a specific layer.
In layer properties, you MUST add a "playAudio" property. The value of the property is a URL to an MP3 file that will be played. The URL can be relative to the URL of the map.
You may use the boolean property "audioLoop" to make the sound loop (thanks captain obvious).
If the "audioVolume" property is set, the audio player uses either the value of the property or the last volume set by the user - whichever is smaller. This property is a float from 0 to 1.0

"playAudioLoop" is deprecated and should not be used anymore.

< Entries and exits Animations >