Villager NPCs - Revision history

DeamonHunter: Some new variables for Villager npcs. But a lot still missing.

2018-09-12T11:57:43Z

Some new variables for Villager npcs. But a lot still missing.

DeamonHunter: Added new variable.

2018-02-01T12:43:24Z

Added new variable.

DeamonHunter: Added totems step.

2018-01-09T10:15:07Z

Added totems step.

DeamonHunter: 2nd step prep.

2018-01-02T09:45:16Z

2nd step prep.

DeamonHunter: Formatting and missing link.

2018-01-01T11:31:47Z

Formatting and missing link.

DeamonHunter: Villager tutorial part 1.

2018-01-01T09:50:38Z

Villager tutorial part 1.

DeamonHunter: Update formatting and added some missing information.

2017-11-17T07:24:56Z

Update formatting and added some missing information.

DeamonHunter: Updated to new category.

2017-07-08T06:55:15Z

Updated to new category.

DeamonHunter: Corrected link

2017-06-28T15:47:29Z

Corrected link

DeamonHunter: Initial commit.

2017-06-24T08:04:53Z

Initial commit.

New page

[[Category:Modding]][[Category:VillagerModding]]
[[:Category:VillagerModding|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 [[Totems|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 [[:Category:VillagerModding|Villager files]] into a single file.

= Creating a *.villagernpc file =
The villager NPC file mainly just specifies each individual [[:Category:VillagerModding|Villager file]] that would be necessary to making an NPC. The basic layout is as follows;
<pre>
{
"code": "staxel.village.character.Emilia",
"name": "Emilia",
"personality": "staxel.village.personality.Cutesy",
"job": "staxel.village.job.Patissier",
"initialDesign": "staxel.village.design.Emilia",
"initialOutfit": "staxel.village.outfit.Emilia",
"regards" : [
{
"kind" : "staxel.concepts.Item",
"attitude" : 4.5,
"concept" : {
"item" : {
"code" : "staxel.item.crops.Banana"
}
}
}
],
"bestFriendUniqueDialogue": [
"staxel.dialoguePool.CecileFond"
]
"homeTotem" : "staxel.totem.EmiliaHome"
}
</pre>

Each property is mainly self explanatory. "initialDesign" is the code of a [[Villager Designs]] file etc. There are two not so self explanatory properties which are to do with villager friendship. This system is currently being developed and will be elaborated on in future.

With all of this done, you know have a villager that can be spawned.

= Config Options =

== "code" ==
'''Valid options (String): <code>A unique string which villager what this object is.</code>'''

'''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.

== "homeTotem" ==
'''Valid options (String): <code>A string that points to a [[Totem]].</code>'''

'''Default Value:''' Can be omitted. Omitting leads to the villager not caring about totems at all.

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.

== "initialDesign" ==
'''Valid options (String): <code>A string that points to a [[Villager Designs|Villager Design]].</code>'''

'''Default Value:''' Can be omitted. Omitting leads to a random design.

This is the design that the villager will have.

== "initialOutfit" ==
'''Valid options (String): <code>A string that points to a [[Villager Outfits|Villager Outfit]].</code>'''

'''Default Value:''' Can be omitted. Omitting leads to a random outfit.

This is the outfit that the villager will have.

== "job" ==
'''Valid options (String): <code>A string that points to a [[Villager Jobs|Villager Job]].</code>'''

'''Default Value:''' Can be omitted. Omitting leads to the villager having no job.

This is the job that the villager will have.

== "name" ==
'''Valid options (String): <code>A string that specifies the default name for this villager.</code>'''

'''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): <code>A string that points to a [[Villager Personalities|Villager Personality]].</code>'''

'''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 (List of Blobs): <code>A blob containing several properties.</code>'''

'''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): <code>A string that points to a [[Dialogue]]</code>'''

'''Default Value:''' Can be omitted. Omiting will just lead to normal dialogue being played.

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.

← Older revision		Revision as of 11:57, 12 September 2018
Line 86:		Line 86:

	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.		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 ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''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 ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''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.

← Older revision		Revision as of 12:43, 1 February 2018
Line 68:		Line 68:

	A string containing the code of the villager this file will be referring to.		A string containing the code of the villager this file will be referring to.
		+
		+
		+	== "hideFromMap" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''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.

@@ Line 30: / Line 30: @@
 # Create the needed [[Villager Designs]] file by following the tutorial at [[Villager Designs#Creating a *.characterdesign file]].
 # Create the needed [[Villager Outfits]] file by following the tutorial at [[Villager Outfits#Creating a *.characteroutfit file]].
 ''This tutorial is in progress. This section will be expanded as pieces of the tutorial are completed.''

← Older revision		Revision as of 09:45, 2 January 2018
Line 29:		Line 29:

	# Create the needed [[Villager Designs]] file by following the tutorial at [[Villager Designs#Creating a *.characterdesign file]].		# Create the needed [[Villager Designs]] file by following the tutorial at [[Villager Designs#Creating a *.characterdesign file]].
		+	# Create the needed [[Villager Outfits]] file by following the tutorial at [[Villager Outfits#Creating a *.characteroutfit file]].

	''This tutorial is in progress. This section will be expanded as pieces of the tutorial are completed.''		''This tutorial is in progress. This section will be expanded as pieces of the tutorial are completed.''
Line 43:		Line 44:
	"job": "staxel.village.job.Patissier",		"job": "staxel.village.job.Patissier",
	"initialDesign": "staxel.village.design.Emilia",		"initialDesign": "staxel.village.design.Emilia",
−	"initialOutfit": "staxel.village.outfit.Emilia",	+	"initialOutfit": "staxel.village.outfit.Emilia",
−	~~"regards" : [~~	+
−	{	+
−	~~"kind" : "staxel.concepts.Item",~~	+
−	~~"attitude" : 4.5,~~	+
−	~~"concept" : {~~	+
−	~~"item" : {~~	+
−	~~"code" : "staxel.item.crops.Banana"~~	+
−	}	+
−	}	+
−	}	+
−	],	+
−	~~"bestFriendUniqueDialogue": [~~	+
−	~~"staxel.dialoguePool.CecileFond"~~	+
−	]	+
	"homeTotem" : "staxel.totem.EmiliaHome"		"homeTotem" : "staxel.totem.EmiliaHome"
	}		}

@@ Line 16: / Line 16: @@
-''Before you start this tutorial, be sure to head through Modding#Getting Started with Staxel Modding.''
+''Before you start this tutorial, be sure to head through [[Modding#Getting Started with Staxel Modding]].''
@@ Line 23: / Line 23: @@
 If you ever do come to see "Begin Update", remove the files from the <code>\mods\</code> 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 <code>\mods\</code> folder.
 == Creating the Villager Files ==

@@ Line 13: / Line 13: @@
 = Creating a *.villagernpc file =
 The villager NPC file mainly just specifies each individual [[:Category:VillagerModding|Villager file]] that would be necessary to making an NPC. The basic layout is as follows;
 <pre>
@@ Line 44: / Line 65: @@
 With all of this done, you know have a villager that can be spawned.
+-->
 = Config Options =
 == "code" ==

@@ Line 46: / Line 46: @@
 = Config Options =
 == "code" ==
-'''Valid options (String): <code>A unique string which villager what this object is.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which villager what this object is.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 57: / Line 56: @@
 == "homeTotem" ==
-'''Valid options (String): <code>A string that points to a [[Totems|Totem]].</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Totems|Totem]].</code>'''
-'''Default Value:''' Can be omitted. Omitting leads to the villager not caring about totems at all.
+'''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.
 == "initialDesign" ==
-'''Valid options (String): <code>A string that points to a [[Villager Designs|Villager Design]].</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Villager Designs|Villager Design]].</code>'''
-'''Default Value:''' Can be omitted. Omitting leads to a random design.
+'''Default Value:''' If not specified, the villager will have a random design.
@@ Line 74: / Line 74: @@
 == "initialOutfit" ==
-'''Valid options (String): <code>A string that points to a [[Villager Outfits|Villager Outfit]].</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Villager Outfits|Villager Outfit]].</code>'''
-'''Default Value:''' Can be omitted. Omitting leads to a random outfit.
+'''Default Value:''' If not specified, the villager will have a random outfit.
 This is the outfit that the villager will have.
 == "job" ==
-'''Valid options (String): <code>A string that points to a [[Villager Jobs|Villager Job]].</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Villager Jobs|Villager Job]].</code>'''
-'''Default Value:''' Can be omitted. Omitting leads to the villager having no job.
+'''Default Value:''' If not specified, the villager will act as if they are jobless.
@@ Line 92: / Line 101: @@
 == "name" ==
-'''Valid options (String): <code>A string that specifies the default name for this villager.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that specifies the default name for this villager.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 101: / Line 110: @@
 == "personality" ==
-'''Valid options (String): <code>A string that points to a [[Villager Personalities|Villager Personality]].</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Villager Personalities|Villager Personality]].</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 110: / Line 119: @@
 == "regards" ==
-'''Valid options (List of Blobs): <code>A blob containing several properties.</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]]of [[Modding_Key_Terms#Blob|Blobs]]): <code>A blob containing several properties.</code>'''
 '''Default Value:''' Can be omitted.
@@ Line 121: / Line 130: @@
 This contains all the information needed for "baseUniqueDialogue", "likedUniqueDialogue", "fondUniqueDialogue" and "bestFriendUniqueDialogue".
-'''Valid options (String): <code>A string that points to a [[Dialogue]]</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Dialogue]]</code>'''
-'''Default Value:''' Can be omitted. Omiting will just lead to normal dialogue being played.
+'''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.

@@ Line 1: / Line 1: @@
-[[Category:Modding]][[Category:VillagerModding]]
+[[Category:Modding]][[Category:Villager Modding]]
-[[:Category:VillagerModding|Villagers]] in Staxel are fairly moddable, with many parts being able to be switched out, and new creations can add to the pool.
+[[:Category:Villager Modding|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;