Rebranding / White labeling your world (beta)

This feature is currently in beta version. We are looking for your feedback.

You can customize WorkAdventure to put your own brand in value. Use the rebranding (or white label) features to:

  • Replace WorkAdventure logos with your own logos
  • Use your own domain name (instead of play.workadventu.re)

Rebranding settings are located in the World edition pop-up.

Using a custom domain

DNS setup

In order to use a custom domain for your WorkAdventure world, you will first need to have a dedicated domain or sub-domain for WorkAdventure.

You need administrator access to your registrar's DNS settings to configure the domain name properly.

Log into your registrar account.

Assuming your domain name is example.com and you want to create a world.example.com, you will need to create a new CNAME record, whose value will be whitelabel.workadventu.re..

Your settings will probably look like this:

Host name Type TTL Data
world CNAME 1H whitelabel.workadventu.re.

The final dot in whitelabel.workadventu.re. is important. Do not forget it!

Domain configuration

When the DNS configuration is done, go to your WorkAdventure account, in the world edition page, and head to the "White Label / Rebranding" section.

White label image information of WorkAdventure and to create your custom domain.
Screenshot of the domain setup

URL structure

When your custom domain is configured, the URL of your rooms will look like this:

https://world.example.com/@/[anything you want]

The /@/ part in the URL is compulsory. The rest of the path can be configured freely in the "slug" field of the room. The slug can contain "/" characters.

Pro tip: in order to have the same exits in your test setup and your production setup, we advise you to use the name of the map file as the slug. So if your map file name is castle.json, you can use castle.json as the slug of your room to have the same exitUrl in testing and in production.

Common questions

Can I host WorkAdventure in a path of an existing domain?

No, you cannot host your world in a sub-path of an existing domain. For instance, if your website is hosted at https://www.example.com, you cannot host your world at https://www.example.com/world/. You can however create a dedicated domain at https://world.example.com

Can I link a domain to several worlds?

Only one world can be linked to one domain, and conversely, only one domain can be used for one world.

Customize graphical assets

Most graphical assets (images) of WorkAdventure can be modified from the World edition pop-up in the admin dashboard.

Next to your world name, click on the pencil icon. A popup will open. Go to the "Graphical assets" section:

Image of all authentication settings for white label.
Screenshot of the "edit your world" - Graphical Assets section

You can replace the following assets:

Logo to be used on the authentication page
WorkAdventure logo setting in the authentication login for white label.
Screenshot of the authentication page
Square logo to be used to toggle menu on the game page
Square logo setting used in WorkAdventure for white label.
Screenshot of the front
Background image of the authentication (replaces the black background)
Image of authentication page setting for WorkAdventure white label
Screenshot of authentication page
Logo displayed on the loading screen
Image of loading screen setting for WorkAdventure white label
Screenshot of loading screen
Logo displayed on the loading screen of the co-website in the game
Image of loading co-website setting for WorkAdventure white label
Screenshot of front with a co-website
Logo displayed on the "Enter your name" page
Image of start scene setting for WorkAdventure white label
Screenshot of select name screen
Image displayed on the error page
Image of error page setting for WorkAdventure white label
Screenshot of error page
Image displayed on the waiting page
Image of waiting page setting for WorkAdventure white label
Screenshot of waiting page