> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inworld.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Innequin

The Innequin Template builds on the [Character template](/unreal-engine/runtime/templates/character) to provide an example of utilizing the Inworld Character graphs and components to create 3D character interactions.

<img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/innequin-level-single.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=d23e6be8c593446449eb3f13a5cf4226" alt="" width="1376" height="942" data-path="img/unreal/runtime/innequin-level-single.png" />

## Run an Innequin Sample Level

1. Open the settings menu in the Content Browser within Unreal.
2. Enable the option for "Show Plugin Content".
3. In the Content Browser, navigate to `/Plugins/InworldInnequin/Levels`.
4. Double-click on the **SingleCharacter** or **MultiCharacter** map.
5. Click the Play-in-Editor button (alt+p) to launch your level.
6. Have a conversation! You can uncheck the microphone to speak or type directly in the text box.

## Template Overview

The Innequin template provides a few sample levels to demonstrate the [Character template](/unreal-engine/runtime/templates/character) components in a 3D environment.

This also includes a collection of Inworld Innequin character assets, and a sample 3D chat interface widget `WBP_Chat3D`.

### SingleCharacter Level

The SingleCharacter level is a simple level that demonstrates a single character interacting with the player.

<Info>
  This character is named "Algo the Apprentice", she is an eager,
  highly trained, and slightly chaotic wizard's apprentice who has mastered her studies and now desperately waits at the tower to be claimed by the right wizard, all while hoping
  the user might be the one she's been searching for.
</Info>

<img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/innequin-level-single-2.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=a17f9efd1d7c2791fe12361a62ec3ea6" alt="" width="1358" height="807" data-path="img/unreal/runtime/innequin-level-single-2.png" />

<Note>
  To send a message to Algo, you can either:

  1. Type your message in the text box and press enter (or click the send button).
       <img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/innequin-level-input.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=361d3fd949c0ba24099ef1f5b79dc1fe" alt="" width="983" height="70" data-path="img/unreal/runtime/innequin-level-input.png" />
  2. Talk using your microphone. Simply click the microphone icon at the left end of the text box to toggle the microphone on or off.

     | **Microphone Off**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |   | **Microphone On**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
     | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | <img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/innequin-level-mic-off.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=32da2e39ef201c4bbaf1ecc647ccd6b2" alt="" width="78" height="63" data-path="img/unreal/runtime/innequin-level-mic-off.png" /> |   | <img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/innequin-level-mic-on.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=205300601635a46ef0a28904e3d9cf57" alt="" width="77" height="63" data-path="img/unreal/runtime/innequin-level-mic-on.png" /> |

     The audio capture component will automatically detect when you have completed your message and send the message to Algo.

  A speech bubble will appear above Algo's head and she will generate a response.
</Note>

#### Character Configuration

In the SingleCharacter level, the Algo character is represented by a **BP\_Innequin\_Character** actor (which inherits from the **BP\_InworldCharacter3D** blueprint from the [Character template](/unreal-engine/runtime/templates/character)).

<img src="https://mintcdn.com/inworldai/14TNMMyEyIwlnPrN/img/unreal/runtime/single-character-outliner.png?fit=max&auto=format&n=14TNMMyEyIwlnPrN&q=85&s=6649fd14dabc0f85567d0b88d422b02f" alt="" width="664" height="376" data-path="img/unreal/runtime/single-character-outliner.png" />

The character is configured in the **Inworld Character** component. In this example, the details are set in the **DT\_InworldCharacters** data table and referenced on the component.

<img src="https://mintcdn.com/inworldai/fTGE5umV6QWd2Zdz/img/unreal/runtime/algo-details.png?fit=max&auto=format&n=fTGE5umV6QWd2Zdz&q=85&s=1c9d3b58dab97d1422b0850ea08b2acd" alt="" width="865" height="415" data-path="img/unreal/runtime/algo-details.png" />

<img src="https://mintcdn.com/inworldai/fTGE5umV6QWd2Zdz/img/unreal/runtime/algo-dt.png?fit=max&auto=format&n=fTGE5umV6QWd2Zdz&q=85&s=e17f5d42fdfba551c144c33a3650b2f0" alt="" width="824" height="1350" data-path="img/unreal/runtime/algo-dt.png" />

<Note>For more information on how to configure a character, see the [Character template](/unreal-engine/runtime/templates/character#character-setup).</Note>

#### Goals and Intents

<Info>Goals allow you to configure predefined character responses and behavior. Intents are sets of phrases used to classify a player's message intention. Intents can be used to activate goals.</Info>

Algo has a few goals and intents configured to her. For instance, when you say "Hello", the "Greeting" goal is activated and she will be instructed to:
<blockquote>Introduce yourself and express hopeful excitement about meeting someone new, comically inquiring if the user might be a wizard seeking an apprentice.</blockquote>

**Algo's Goals:**

<img src="https://mintcdn.com/inworldai/vNa4wGXw41dkUd1l/img/unreal/runtime/goals-algo.png?fit=max&auto=format&n=vNa4wGXw41dkUd1l&q=85&s=9e56c804b390c6fca7f97832e2817a77" alt="" width="904" height="605" data-path="img/unreal/runtime/goals-algo.png" />

* **Greeting**
  * Instruction: "Introduce yourself and express hopeful excitement about meeting someone new, comically inquiring if the user might be a wizard seeking an apprentice."
  * Intents:
    * Greeting: "Hello", "Hi there", "Hey"
      <img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/intent-greeting.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=18d1286ef5cfaa4c18aebeb268650b8e" alt="" width="930" height="673" data-path="img/unreal/runtime/intent-greeting.png" />
* **AskForHelp**
  * Instruction: "Eagerly frame the user's request for help as a adventurous quest and then ask what you can assist them with."
* **AskForJoke**:
  * Verbatim: "Okay, what's the difference between a wizard and a sorcerer? About three years of student loan debt."
* **Goodbye**:
  * Instruction: "Express hope that the user will return soon and wish them well in their travels."

<Note>For more information on how to configure goals and intents, see the [Character template](/unreal-engine/runtime/templates/character#goals).</Note>

### MultiCharacter Level

The MultiCharacter level is a more complex level that demonstrates a group of characters conversing and interacting with the player.

<Info>
  In this conversation we have:

  * Aurora Summers, a seasoned, middle-aged detective, is observant and analytical, with a keen eye for detail honed by years of cracking tough cases.
  * Marcus Thompson, a curious and charismatic young adult journalist whose persistent, investigative nature makes him formidable in reporting.
</Info>

<img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/multi-character-level.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=7267aabac8c43d04860517d5f8eb9281" alt="" width="1167" height="940" data-path="img/unreal/runtime/multi-character-level.png" />

In a group conversation characters will automatically take turns speaking with eachother. The player is able to interrupt and join in the conversation at any time.

<img src="https://mintcdn.com/inworldai/KZhFeSYtETb5Csnp/img/unreal/runtime/multi-character-player.png?fit=max&auto=format&n=KZhFeSYtETb5Csnp&q=85&s=4e973774b76dc15121d22f1b9c081d81" alt="" width="1152" height="808" data-path="img/unreal/runtime/multi-character-player.png" />

#### Conversation group

In the MultiCharacter level, the conversation group is created by a **BP\_ConversationGroup** actor (a blueprint from the [Character template](/unreal-engine/runtime/templates/character)).

<img src="https://mintcdn.com/inworldai/cjOBLSaT-WmNEJqi/img/unreal/runtime/conversation-group-outliner.png?fit=max&auto=format&n=cjOBLSaT-WmNEJqi&q=85&s=77f3affc7dc4aecf9d390c2e85a2f50a" alt="" width="732" height="61" data-path="img/unreal/runtime/conversation-group-outliner.png" />

This blueprint actor allows you to initialize a conversation group with a set of characters from the level. It also has some basic automated response settings.

<img src="https://mintcdn.com/inworldai/cjOBLSaT-WmNEJqi/img/unreal/runtime/conversation-group-details.png?fit=max&auto=format&n=cjOBLSaT-WmNEJqi&q=85&s=56f9178a5025e9f3531473d7683b2cf1" alt="" width="768" height="522" data-path="img/unreal/runtime/conversation-group-details.png" />

In this example we have configured the conversation group to trigger responses from the characters automatically every 5 seconds of silence.

<Note>For more information on conversation groups, see the [Character template](/unreal-engine/runtime/templates/character#inworld-conversation-group-uobject).</Note>

### Director Mode Level

The Director Mode level is essentially a replica of the [MultiCharacter Level](#multicharacter-level), but specifically configured to demonstrate the **Speaker Rule Director**.

While the MultiCharacter level uses dynamic AI speaker selection, this level enforces a strict, turn-based speaker order. This is useful for scenarios like board games or scripted sequences where AI randomness is not desired.

<img src="https://mintcdn.com/inworldai/kafzxT3qq3CaZZWJ/img/unreal/runtime/multi-character-director-mode.png?fit=max&auto=format&n=kafzxT3qq3CaZZWJ&q=85&s=9b12d45debda75cf878ded52028b6bed" alt="" width="2559" height="1364" data-path="img/unreal/runtime/multi-character-director-mode.png" />

In this example, the characters (Aurora and Marcus) follow a predefined sequence instead of using the dynamic AI speaker selection. As shown in the configuration (bottom right of the screenshot), the sequence is defined as: **Aurora -> Aurora -> Aurora**.

#### Level Setup

1. **Map**: `MultiCharacter_Director`
2. **GameMode**: `BP_Innequin_Director_GameMode`

The logic for activating the rule is handled in the GameMode. On `BeginPlay`, the GameMode gets the `RuleDirector` from the conversation group component and activates the "TestRule".

<img src="https://mintcdn.com/inworldai/9TTOUOKOkeJ9Q5_F/img/unreal/runtime/editor_director_mode_activate.png?fit=max&auto=format&n=9TTOUOKOkeJ9Q5_F&q=85&s=c0422337ed144ef398e2186fdc6c116e" alt="" width="1470" height="700" data-path="img/unreal/runtime/editor_director_mode_activate.png" />

<Note>For more information on how to configure the Speaker Rule Director, see the [Character template](/unreal-engine/runtime/templates/character).</Note>
