Latest revision as of 07:57, 12 September 2018

Villagers in Staxel are fairly moddable, with many parts being able to be switched out, and new creations can add to the pool.

This page is about Villager NPC, these are found in .villagernpc files and contains information for how to create a character. That is it contains info for;

• What job this npc should have.
• What personality this npc has.
• What the npc will look like.
• The totem that signifies their home
• Regards and dialogues specific for the villagers happiness towards you.

This therefore contains all the information needed to spawn a villager into the world. It basically brings together all other Villager files into a single file.

Creating a *.villagernpc file

Creating a Villager is an involved affair. Common Villagers need at least 5 files per villager, each of which are of differing sizes.

Before you start this tutorial, be sure to head through Modding#Getting Started with Staxel Modding.

If you are working with the Staxel Launcher then after going through the setup tutorial, then open it up and make sure there is no game update available. If there is an update available, download it. This is to make sure you don't accidentally lose the files while you are working on them.

If you ever do come to see "Begin Update", remove the files from the \mods\ before starting. Once that is checked, then we can start creating the stuff needed to get the your tile into the game. Make sure that all files are already ready in the \mods\ folder.

Creating the Villager Files

Now as this is an involved process, the following steps will point you to new pages which will tell you how to create the individual files.

1. Create the needed Villager Designs file by following the tutorial at Villager Designs#Creating a *.characterdesign file.
2. Create the needed Villager Outfits file by following the tutorial at Villager Outfits#Creating a *.characteroutfit file.
3. Step coming soon! (Villager Personalities is not complete yet)
4. Step coming soon! (Villager Jobs is not complete yet)

At this point you should have everything you need to have a working NPC. However this NPC will almost certainly need a house to live. That being said, if your NPC is created by other means, such as Code Based Mod or Festivals, then you will not need to do the following step.

• Create a Totem that will serve as the NPC's home. Do this by following the tutorial at Totems#Creating a *.totem file

This tutorial is in progress. This section will be expanded as pieces of the tutorial are completed.

Config Options

"code"

Valid options (String): A unique string which villager what this object is.

Default Value: No default value is specified. Always need to provide your own.

A string containing the code of the villager this file will be referring to.

"hideFromMap"

Valid options (Bool): True or False.

Default Value: If not specified, will default to False.

This determines whether or not the villager will be hidden when the player goes into Map Mode. Makes it much harder to find the NPC.

"homeTotem"

Valid options (String): A string that points to a Totem.

Default Value: If not specified, the villager will not care for totems.

This is the totem that the villager will look for at it's home. If this home is missing then the villager can have extra stuff defined in it's personality.

"ignoreTavern"

Valid options (Bool): True or False.

Default Value: If not specified, will default to False.

Whether or not this villager will ignore the tavern if their home is missing. May be used in other similar circumstances.

"ignoreTotemClaimed"

Valid options (Bool): True or False.

Default Value: If not specified, will default to False.

Whether or not this villager can \"claim\", and count it as another villagers totem. For example, the villager, Alua, uses this to claim Oscar's home as their own. Thus giving them a spawn point until they leave the town again.

"initialDesign"

Valid options (String): A string that points to a Villager Design.

Default Value: If not specified, the villager will have a random design.

This is the design that the villager will have.

"initialOutfit"

Valid options (String): A string that points to a Villager Outfit.

Default Value: If not specified, the villager will have a random outfit.

This is the outfit that the villager will have.

"introductionDialogue"

Valid options (String): A string that points to a Dialogue

Default Value: If not specified, normal dialogue will play.

This adds a Dialogue that must be played before all other dialogue. This dialogue should act as the Introduction and have the Introduction Type.

"job"

Valid options (String): A string that points to a Villager Job.

Default Value: If not specified, the villager will act as if they are jobless.

This is the job that the villager will have.

"name"

Valid options (String): A string that specifies the default name for this villager.

Default Value: No default value is specified. Always need to provide your own.

This is the default name the villager will have. This name can be translated into a different language however.

"personality"

Valid options (String): A string that points to a Villager Personality.

Default Value: No default value is specified. Always need to provide your own.

This is the personality that the villager will have.

"regards"

Valid options (Listof Blobs): A blob containing several properties.

Default Value: Can be omitted.

Regards are a system that involves villager friendship. Will elaborate in the future.

Unique Dialogues

This contains all the information needed for "baseUniqueDialogue", "likedUniqueDialogue", "fondUniqueDialogue" and "bestFriendUniqueDialogue".

Valid options (String): A string that points to a Dialogue

Default Value: If not specified, normal dialogue will play

These properties adds in extra dialogues that can play once the villager likes you enough. (Listed above in ascending order). More elaborations will be added later when regards are elaborated.