Table of contents
1. Downloading and importing the file
To start using ChatMapper, the Scenario Template can be downloaded. It is recommended to use this file to start a new project, especially in the case of ChatMapper beginners, as it comes with Actors, custom fields, and conversations already set up.
After clicking on the link, a “Download” window will appear – click Save.
Note that ChatMapper is a Windows-only tool – if you are using macOS or a Linux distribution, you will need to run it in a Windows VM (such as Parallels on macOS, or Wine on Linux). This guide assumes you are using Windows.
There are two types of files commonly encountered when working with ChatMapper.
CMP files do not bundle external assets, and are suggested for most projects (most assets, such as 3D models, can be imported directly into the LearnBrite platform).
It is however possible to export a bundled version of the CMP which will include the assets imported into the ChatMapper project as well – there are “CMPKG” (ChatMapper Package) files, like the Scenario Template.
Open the file after downloading – ChatMapper will import it, and will ask to open the project. Click Yes.
If you have already imported the project in the past, ChatMapper will ask to overwrite the existing import first. In that case, click Yes, and then open the project when asked.
By default, the project will be saved in the following folder:
C:/Users/USERNAME/Documents/Chat Mapper/Imported Packages
2. Using ChatMapper
A detailed guide on ChatMapper can be found at the LearnBrite Academy website.
The Template has been set up with Actors and Conversations.
The project includes four Actors: Player, Narrator, Jane, and Michael.
Tok see the details of each actor and modify them, click on their name on the left pane, and their details will be displayed on the Properties pane (on the right by default).
Both Player and Narrator are special actors.
- Player, as the character of the user, must have isPlayer checked and isNPC unchecked. In the screenshots some additional details are defined, such as the player’s Voice (UK English Male).
- Narrator is also a special actor, representing the “camera” in the experience. To work as such, it must have no avatar_externalId, and both isPlayer and isNPC must be unchecked. Whenever a dialogue node has the Conversant set to Narrator, the avatar who is speaking will look directly at the camera (it will otherwise look at the Conversant’s avatar). If Narrator is set as the Actor of a node, the camera will not move from its previous position.
Jane and Michael are normal actors. Taking Jane as an example, here are all her properties and what they do:
- Name: the actor’s name, also used within Scenario (it is displayed above a character’s head).
- Pictures: this is an image used purely for decorative purposes within ChatMapper, to show an actor’s image in a conversation.
Any image can be used, though it should be placed within the same folder as the .cmp file (in the case of the template project, “C:/Users/USERNAME/Documents/Chat Mapper/Imported Packages/Scenario Template”).
If placed outside of that folder, it will not be included correctly in any .cmpkg (ChatMapper Package) exported.
- Description: used only in ChatMapper – will fill the tooltip that shows when hovering over a character, useful to show some additional information about the actor that is not critical.
- IsPlayer: this should be unchecked for every Actor that is not the user’s.
- onclick: the action to trigger when clicking on the avatar within the 3D environment. Please refer to the Scenario Actions guide for more details.
Jane and Michael’s onclick do something straightforward: Jane’s launches the conversation called “Conversation with Jane”, and clicking on Michael starts “Conversation with Michael”.
- avatar_externalId: this is an ID that can be obtained from https://app.learnbrite.com/bots , where you can create your own bots.
- avatar_spotTag: name of the hotspot where the actor should be placed within the 3D environment.
- isNPC: is checked (as it should for every character that is not the user’s).
- Voice: the actor’s voice, from ResponsiveVoice’s catalog.
- Voice_parameters: additional parameters for the actor's Voice (pitch, rate of speech, volume). See Speech, SFX, Ambient > How to Make Actors using the Same Voice Sound Different
- pipConfig: configuration for the Picture in Picture avatar. See Avatars & Bots > Is there an option to add a picture-in-picture
- avatar_height: the height of the camera when the actor is speaking.
In the project are two conversations, “Conversation with Jane” and “Conversation with Michael”. You can open each by going to the “Conversations” tab in the left pane and double-clicking on any of the two.
The conversation with Jane includes some helpful tips on using ChatMapper, as well as one of the most important interactive elements in dialogue: a choice (highlighted in ChatMapper using red, white and green nodes). All of this can and should be modified as needed.
3. Uploading to Dashboard
3.1 Export the CMPKG
When the project is ready to be tested, go to File > Export > ChatMapper Package (CMPKG). This will create a package like the original Scenario Template one.
3.2 Create the scenario
The package can be uploaded directly on the LearnBrite Dashboard > Scenarios page.
On that page, click on Create a new Scenario, and fill in the form with a name for your scenario (it will not be visible to users, so it can be named as you prefer) and choosing the recently-exported CMPKG file. Click Create to upload the package file and create the scenario.
3.3 Create the space
On the Dashboard page, click on Create a new Space. In the next page you can choose one of the many environments included in the platform, as well as a name for the space (which is visible to users) and whether the space is a Virtual Meeting Room (i.e. if users are in a multi-user session, or in a single-user one). Create the space by clicking on Create Space at the bottom.
3.4 Assign the scenario to the space
In the list of spaces on the Dashboard homepage, click on the three vertical dots on the new space, and select Edit Space
At the bottom of this new page, click on Show advanced settings, and expand the section called Scenario. Then select the scenario you just created from the dropdown, and click Save at the bottom. You’re done!
You can now access your space by clicking on it on the Dashboard homepage. Enjoy!
How useful was this article?
Click on a star to rate it!
We are sorry that this article was not useful for you!
Let us improve this article!
Thanks for your feedback!