Characters

Overview
Characters are probably one of the most important parts of your novel, not only used for displaying them as sprites but also to display their dialogs.
Properties
The following table lists all the properties you can set for each character.
Name
Type
Optional
Description
name
string
Yes
The name that will be shown when this character speaks.
​
Supports storage and translation interpolations.
color
string
Yes
A valid CSS color which will be used to color the character's name.
directory
string
Yes
Specifies the sub-directory where the sprites and expressions images for the character are stored in case they are not in the root assets/characters directory.
sprites
object
Yes
An object with the identifiers and file names for each sprite available for the character.
default_expression
string
Yes
 Side image to show every time the character speaks.
expressions
object
Yes
An object with the identifiers and file names for each side expression available for the character.
nvl
boolean
Yes
Default is false.
​
Whether the character's dialogs should be shown in NVL mode.
type_animation
boolean
Yes
Default is true. 
​
This property indicates whether the typewriter animation should be used when the character speaks or not.
Declaration
Declaring characters is really simple. 
First, you need to define an identifier. This is what you'll use for the dialog and show character actions.
 We'll choose the identifier y, short for Yui in this tutorial.
1
monogatari.characters ({
2
    'y': {
3
​
4
    }
5
});
Copied!
Do you have more than one character? No problem! You can define as many characters as you want, just make sure that each character has a unique identifier.
1
monogatari.characters ({
2
    'y': {
3
​
4
    },
5
    'm': {
6
    
7
    }
8
});
Copied!
We've come up with our identifiers and they point to an empty object. Inside this object is where we'll define each of the properties we need for each character.
Name and Color
The most basic properties are the name and color for our characters. The name will appear in the textbox every time the character speaks and the color specifies what color that name will be. 
1
monogatari.characters ({
2
    'y': {
3
        name: 'Yui',
4
        color: '#00bfff'
5
    }
6
});
Copied!
Character Sprites
Since we are building visual novels, chances are we also need images for our characters. 
All your character's sprites should be placed in your assets/characters directory, let's see what that looks like.
1. Enter the assets directory
2. Enter the characters directory
3. Place all your sprite images
4. Declare your assets
Now that we have all our sprites in our assets directory, we need to declare them so monogatari knows about them. To do so, we'll use the sprites property of our character:
1
monogatari.characters ({
2
    'y': {
3
        name: 'Yui',
4
        color: '#00bfff', 
5
        sprites: {
6
            angry: 'normal.png',
7
            happy: 'happy.png',
8
            normal: 'normal.png',
9
            sad: 'sad.png',
10
            surprised: 'surprised.png'
11
        }
12
    }
13
});
Copied!
Notice how for each sprite we assigned two things:
1. A key or identifier which is the way we'll refer to that specific sprite.
2.The name of the file.
1
identifier: 'file.name'
Copied!
Both items are independent of each other so while in the last example we used identifiers similar to the file names, we could have chosen any identifier, the following would be perfectly valid for example:
1
 someKey: 'normal.png'
2
 happy: 'my_file_name.png'
Copied!
To learn how to show a character sprite, go over to the Show Character action.
Show Character
Custom Sub-directory
In the  Character Sprites section we added all of our character sprite images into the assets/characters directory. This approach is pretty straight forward but can become a bit troublesome as you add more characters. For starters, the directory could start feeling cluttered and you would not be able to use the same name on different files without them getting overwritten.
A solution for this issue is to have a different directory for each character where we'll place all the assets for that character alone. This is achieved by specifying the directory property in your character declaration. This property expects the name of a sub-directory inside the assets/characters directory. For example, if you create a sub-directory assets/characters/my-character then you should set the directory property to 'my-character'. Let's take a look at the whole process:
1. Create your sub-directory
2. Place all your character assets in that sub-directory
3. Set the directory property in your declaration
Now that we've created the sub-directory and placed all our assets for a specific character in it, then we must specify the directory property in our character so monogatari knows where the files are located.
1
monogatari.characters ({
2
    'y': {
3
        name: 'Yui',
4
        color: '#00bfff',
5
        directory: 'yui', 
6
        sprites: {
7
            angry: 'normal.png',
8
            happy: 'happy.png',
9
            normal: 'normal.png',
10
            sad: 'sad.png',
11
            surprised: 'surprised.png'
12
        }
13
    }
14
});
Copied!
Expressions / Side Images
It is also possible to define side images or expressions to show on the textbox when your character speaks.
1. Add your expression images to your assets
For this example we'll add all our expressions in their own directory. This is not required though and you can place them right where your character's sprites are.
Now that we've created our expressions sub-directory, we'll place all our expression images in it.
2. Add the expressions to your declaration
Now that we've added our files, we need to define them in our character declaration by defining the expressions property. Just like the sprites property, it expects an identifier/filename list.
1
monogatari.characters ({
2
    'y': {
3
        name: 'Yui',
4
        color: '#00bfff',
5
        directory: 'yui', 
6
        sprites: {
7
            angry: 'normal.png',
8
            happy: 'happy.png',
9
            normal: 'normal.png',
10
            sad: 'sad.png',
11
            surprised: 'surprised.png'
12
        },
13
        expressions: {
14
            angry: 'expressions/normal.png',
15
            happy: 'expressions/happy.png',
16
            normal: 'expressions/normal.png',
17
            sad: 'expressions/sad.png',
18
            surprised: 'expressions/surprised.png'
19
        }
20
    }
21
});
Copied!
Notice how we added the expressions/ prefix to all of the file names to account for the expressions directory we put the files in. If we hadn't done that and we had placed them right with our sprites, the prefix would not be needed but we would have to change the names of the files so that they don't overlap with the sprites ones.
To learn how to show this expressions in a dialog, go over the Dialog action.
Dialogs
Default Expression
It is also possible to define a default side image / expression for your character. This default one will be shown for all of your character's dialogs that do not specify any other expression.
The default_expression property expects the identifier of one of your expressions as its value. Previously we defined the normal expression for our character:
1
normal: 'expressions/normal.png'
Copied!
If we wanted to make that one the default expression, then we'd need to set the default_expression property to normal:
1
monogatari.characters ({
2
    'y': {
3
        name: 'Yui',
4
        color: '#00bfff',
5
        directory: 'yui', 
6
        sprites: {
7
            angry: 'normal.png',
8
            happy: 'happy.png',
9
            normal: 'normal.png',
10
            sad: 'sad.png',
11
            surprised: 'surprised.png'
12
        },
13
        expressions: {
14
            angry: 'expressions/normal.png',
15
            happy: 'expressions/happy.png',
16
            normal: 'expressions/normal.png',
17
            sad: 'expressions/sad.png',
18
            surprised: 'expressions/surprised.png'
19
        },
20
        default_expression: 'normal'
21
    }
22
});
Copied!
NVL Mode
By default, characters will speak in adv mode. In ADV mode, the textbox appears in the bottom of the screen and only displays a dialog at a time. NVL mode will make the textbox cover the whole screen and will display several dialogs in a log format.
The nvl property accepts a boolean value (true or false) and is set to false by default. Setting it to true will make all of the character's dialogs to be shown in nvl mode.
1
monogatari.characters ({
2
    'y': {
3
        name: 'Yui',
4
        color: '#00bfff',
5
        directory: 'yui', 
6
        sprites: {
7
            angry: 'normal.png',
8
            happy: 'happy.png',
9
            normal: 'normal.png',
10
            sad: 'sad.png',
11
            surprised: 'surprised.png'
12
        },
13
        expressions: {
14
            angry: 'expressions/normal.png',
15
            happy: 'expressions/happy.png',
16
            normal: 'expressions/normal.png',
17
            sad: 'expressions/sad.png',
18
            surprised: 'expressions/surprised.png'
19
        },
20
        default_expression: 'normal',
21
        nvl: true
22
    }
23
});
Copied!
If you want to learn more about the different dialog modes, check the Dialog action and the Text Box component.
Dialogs
Text-Box
Typewrite Animation
Monogatari allows you to disable the typewrite animation for your game from your game's settings, however, some times you only want to disable the animation for a specific character.
The type_animation property accepts a boolean value (true or false) and is set to true by default. Setting it to false will disable the animation for all of that character's dialogs.
1
monogatari.characters ({
2
    'y': {
3
        name: 'Yui',
4
        color: '#00bfff',
5
        directory: 'yui', 
6
        sprites: {
7
            angry: 'normal.png',
8
            happy: 'happy.png',
9
            normal: 'normal.png',
10
            sad: 'sad.png',
11
            surprised: 'surprised.png'
12
        },
13
        expressions: {
14
            angry: 'expressions/normal.png',
15
            happy: 'expressions/happy.png',
16
            normal: 'expressions/normal.png',
17
            sad: 'expressions/sad.png',
18
            surprised: 'expressions/surprised.png'
19
        },
20
        default_expression: 'normal',
21
        nvl: true,
22
        type_animation: false
23
    }
24
});
Copied!