Villager Personalities - Revision history

DeamonHunter: Added new variable.

2018-02-01T11:57:07Z

Added new variable.

DeamonHunter: Updated tutorial.

2018-01-23T11:23:32Z

Updated tutorial.

DeamonHunter: Update formatting and added some missing information.

2017-11-21T04:21:20Z

Update formatting and added some missing information.

DeamonHunter: Updated to new category.

2017-07-08T06:56:32Z

Updated to new category.

DeamonHunter: Initial commit.

2017-06-04T10:27:01Z

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 Personalities, these are found in .villager files and contains information for;

* Several types of dialogue. Normal and when someone is theiving.
* Set regards [Need to look into this sorry.]
* Set idle script

As such this file, in essence, creates the entirety of the villagers personality. This file does not affect the villager's Job which is handled by [[Villager Jobs|.viallagerjob]] files.

= Creating a *.personality file =

[Under Construction]

= Config Options =
== "canGiveQuests" ==
'''Valid options (Bool): <code>A boolean value.</code>'''

'''Default Value:''' True

This determines whether or not this villager can give quests to the player.

== "canLeaveTown" ==
'''Valid options (Bool): <code>A boolean value.</code>'''

'''Default Value:''' True

This determines whether or not this villager can leave the town when their totem is incomplete or broken.

== "code" ==
'''Valid options (String): <code>A unique string which species 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 item the blob will be referring to.

== "dialoguePools" ==
'''Valid options (List of strings): <code>A list of strings which point to a [[Dialogue Pools|Dialogue Pool]] code each</code>'''

'''Default Value:''' Null or nothing specified.

This is a list of strings that point towards the dialogue pools which will be used for general talking. These do not include dialogues for jobs or theft.

== "idleScript" ==
'''Valid options (String): <code>A string represented pointing to a script that handles idling.</code>'''

'''Default Value:''' "staxel.script.IdleNpcScript"

This determines what code should dictate how the npc's will do while idle. These scripts are snippets of c# code, but the one that is most often used is "staxel.script.IdleNpcScript".

To create your own script, you will have to follow [[Code Based Mod]] and implement a class which inherits IScript.

== "suppressGeneralDialogue" ==
'''Valid options (Bool): <code>True or False</code>'''

'''Default Value:''' False

This defines whether or not the "General" dialogue, or the dialogue that all villagers have, will not be played. (i.e When this property is true, it will not play normal dialogue.)

== "theftDialoguePools" ==
'''Valid options (List of strings): <code>A list of strings which point to a [[Dialogue Pools|Dialogue Pool]] code each</code>'''

'''Default Value:''' Null or nothing specified.

This is a list of strings that point towards the dialogue pools which will be used for general talking. These do not include dialogues for jobs or theft.

== "typicalRegards" ==

[Need to look into]

← Older revision		Revision as of 11:23, 23 January 2018
Line 11:		Line 11:


−	= Creating a *.personality file =	+	= Creating a New Villager Personality =
		+	Villager personalities (or *.villager files) are fairly light files. These are mostly to do with how the Villager will act, which is mostly done through [[Dialogue]]. You can have a personality file without any dialogue, but then it will be down to generic dialogue. So feel free to continue, even without dialogue.
		+
		+
		+	''Before you start this tutorial, be sure to head through [[Modding#Getting Started with Staxel Modding]].''
		+
		+
		+	== Adding the Villager Personality via Asset Manager ==
		+	Follow [[Modding#Using the AssetManager to Create Mods]] to open up the Asset Manager. With the Asset Manager open, head to <code>View → Characters and Animals → Villager Assets</code>. When the new window is open, head to <code>Asset → Add → New Asset</code> and the following window will show up.
		+
		+	[[File:Asset Manager - New Asset.png]]
		+
		+	First click on the button Asset Path and navigate upwards to the <code>/content/</code> folder. Once there, open the <code>/mods/</code> folder and create a new folder. Name this new folder to what you want the mod to be called and then open this new folder. When you open this folder give the asset a name, then click on the drop down and select ''<tt>Villager Personality Asset</tt>''. Then click save, give the item a code then click OK.
		+
		+
		+	After the asset is created, it will have been automatically selected. With that it is now time to tell the game what you want to do with this Villager Design. The following set of steps highlight the important properties, however you can mess with any property.
		+
		+	# Click on CanGiveQuests. Set to True or False.
		+	# Click on CanLeaveTown. Set to True or False. (Normally true for villagers, but false for Store Managers/ Mayor.)
		+	# Click on DialoguePools. Click on the dropdown. Select the pool you want and click add. Keep doing this for every [[Dialogue Pools]] you want. These should all have the type of "Personality".
		+	# If you have a [[Dialogue Pools\|Dialogue Pool]] that must go first. (Maybe because it has a first time greeting in it.) Click on PrimaryDialogue and select that Dialogue. This should all have the type of "Personality".
		+	# If you have dialogue that is about the season. Then click on the dropdown to the left of Seasonal Dialogue. And add each dialogue to the season you want it in.
		+	# Click on SuppressGeneralDialogue. Set to True or False. (This largely depends on whether or not you want the character to say generic dialogue (true), or only your dialogue (false).)
		+	# If you have dialogue that is about theft. Click on TheftDialoguePools. Click on the dropdown. Select the pool you want and click add. Keep doing this for every [[Dialogue Pools]] you want. These should all have the type of "Theft".
		+
		+
		+	With that, hit Crtl+S to save the file. And then go to <code>File → All Assets → Build and Validate Assets</code>. If this succeeds, then HURRAY! you have a new tile in the game. If it fails, try and read the error to see what you have done wrong. If you are confused then go to the #Modding channel on Discord and ask there.
		+
		+
		+	== Adding the Villager Personality via Text Files ==
		+
		+	''Follow [[Modding#Using a Text Editor to Create Mods]] in order to be properly set up for this step.''
		+
		+	Create a text file and rename its extension to '''<tt>*.characterdesign</tt>'''. After creating this file, open it up in the text editor of your choice by right clicking the file and choosing open. You may want to force set the default program as well. Once this file is open copy the following template into the file.
		+
		+	<pre>
		+	{
		+	"code": "staxel.village.personality.Caithgirl",
		+	"dialoguePools": [ "staxel.dialoguePool.Caithgirl"],
		+	"primaryDialogue" : "staxel.dialoguePool.Caithgirl",
		+	"theftDialoguePools": [],
		+	"seasonalDialogue": {
		+	"Winter": "staxel.dialoguePool.CaithGirlWinter"
		+	},
		+	"suppressGeneralDialogue": false,
		+	"canGiveQuests": true,
		+	"canLeaveTown": true
		+	}
		+	</pre>
		+
		+	Sadly there are no pictures for this, as there is nothing to show. However here are the explanations for this file above which contain things known as properties. These explanations are listed below.
		+
		+	* [[#"code"\|"code"]]: A unique [[Modding_Key_Terms#String\|String]] that would be used to identify this object from others. For example this is like "staxel.item.crafting.BakingPowder" or "staxel.tile.grass". You will most commonly want to use you use the path to the Accessory Model but replace <code>/</code> with <code>.</code>, as this will ensure your design will have a different code to all other designs.
		+	* [[#"dialoguePools"\|"dialoguePools"]]: A [[Modding_Key_Terms#List\|List]] of [[Modding_Key_Terms#Strings\|Strings]] that each contain the code to a [[Dialogue Pools\|Dialogue Pool]]. These dialogue pools should all have the type "Personality". These dialogues get randomly selected whenever talking commences.
		+	* [[#"primaryDialogue"\|"primaryDialogue"]]: A [[Modding_Key_Terms#Strings\|Strings]] that contains the code to a [[Dialogue Pools\|Dialogue Pool]]. This dialogue pool should have the type "Personality". This makes this Dialogue the ''first'' dialgoue to show up. Before any random dialogue will show. Helpful if the NPC has important dialogue or a custom greeting.
		+	* [[#"theftDialoguePools"\|"theftDialoguePools"]]: A [[Modding_Key_Terms#List\|List]] of [[Modding_Key_Terms#Strings\|Strings]] that each contain the code to a [[Dialogue Pools\|Dialogue Pool]]. These dialogue pools should all have the type "Theft". These dialogues will show up randomly when a player has stolen from tills.
		+	* [[#"suppressGeneralDialogue"\|"suppressGeneralDialogue"]]: A [[Modding_Key_Terms#Bool\|Bool]]. Keep <code>False</code> to let the NPC say other generic lines. Set to <code>True</code> in order to only have [[#P"primaryDialogue"]], [[#"dialoguePools"]], [[#"theftDialoguePools"]] and [[#"seasonalDialogue"]] from this personality to play.
		+	* [[#"canGiveQuests"\|"canGiveQuests"]]: A [[Modding_Key_Terms#Bool\|Bool]]. Set to <code>True</code> in order to allow this NPC to get random Quests. Set to <code>False</code> to disallow that.
		+	* [[#"canLeaveTown"\|"canLeaveTown"]]: A [[Modding_Key_Terms#Bool\|Bool]]. Set to <code>True</code> in order to allow this NPC to leave town when their home is destroyed. Set to <code>False</code> to disallow that. (Generally kept to true unless the NPC is truly important to the world. (Shop Keepers and the Mayor are False.)
		+
		+	The only thing left is [[#"seasonalDialogue"\|Seasonal Dialogue]]. Which itself is a [[Modding_Key_Terms#Blob\|Blob]]. It's commonly created like;
		+
		+	<pre>
		+	"seasonalDialogue": {
		+	"Winter": "staxel.dialoguePool.CaithGirlWinter",
		+	"Summer": "staxel.dialoguePool.CaithGirlSummer",
		+	"Autumn": "staxel.dialoguePool.CaithGirlAutumn",
		+	"Spring": "staxel.dialoguePool.CaithGirlSpring"
		+	},
		+	</pre>
		+
		+	Each property is a [[Dialogue Pools\|Dialogue Pool]] and each one does not need to be included.
		+
		+
		+	After you have done editing the file, head to <code>gamedata/bin/</code> folder, and start up <code>Staxel.ContentBuilder.exe</code>. When this has started up, click '''<tt>Validate Resources</tt>''' and wait until the progress bar has done. And with that you should have a working item. If you are confused then go to the #Modding channel on Discord and ask there.

−	~~[Under Construction]~~

	= Config Options =		= Config Options =

@@ Line 114: / Line 114: @@
 This determines whether or not this villager can leave the town when their totem is incomplete or broken.
@@ Line 185: / Line 194: @@
 == "typicalRegards" ==
-[Need to look into]
+Typical Regards is not yet implemented completely.

@@ Line 16: / Line 16: @@
 = Config Options =
-== "canGiveQuests" ==
+== "code" ==
-'''Valid options (Bool): <code>A boolean value.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which personality this object is.</code>'''
-'''Default Value:''' True
+'''Default Value:''' No default value is specified. Always need to provide your own.
-This determines whether or not this villager can give quests to the player.
+A string containing the code of the personality the blob will be referring to.
-== "canLeaveTown" ==
+== "canGiveQuests" ==
-'''Valid options (Bool): <code>A boolean value.</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' True
+'''Default Value:''' If not specified, will default to true.
-This determines whether or not this villager can leave the town when their totem is incomplete or broken.
+This determines whether or not this villager can give quests to the player.
-== "code" ==
+== "canLeaveTown" ==
-'''Valid options (String): <code>A unique string which species what this object is.</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' No default value is specified. Always need to provide your own.
+'''Default Value:''' If not specified, will default to true.
-A string containing the code of the item the blob will be referring to.
+This determines whether or not this villager can leave the town when their totem is incomplete or broken.
 == "dialoguePools" ==
-'''Valid options (List of strings): <code>A list of strings which point to a [[Dialogue Pools|Dialogue Pool]] code each</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|Strings]]): <code>A list of strings which point to a [[Dialogue Pools|Dialogue Pool]] code each.</code>'''
-'''Default Value:''' Null or nothing specified.
+'''Default Value:''' If not specified, will not have any dialogue.
@@ Line 53: / Line 53: @@
 == "idleScript" ==
-'''Valid options (String): <code>A string represented pointing to a script that handles idling.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|Strings]]): <code>A string represented pointing to a [[Script]] that handles idling.</code>'''
 '''Default Value:''' "staxel.script.IdleNpcScript"
@@ Line 61: / Line 61: @@
 To create your own script, you will have to follow [[Code Based Mod]] and implement a class which inherits IScript.
 == "suppressGeneralDialogue" ==
-'''Valid options (Bool): <code>True or False</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False
+'''Default Value:''' If not specified, will default to False.
@@ Line 73: / Line 103: @@
 == "theftDialoguePools" ==
-'''Valid options (List of strings): <code>A list of strings which point to a [[Dialogue Pools|Dialogue Pool]] code each</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|String]]): <code>A list of strings which point to a [[Dialogue Pools|Dialogue Pool]] code each</code>'''
-'''Default Value:''' Null or nothing specified.
+'''Default Value:''' If not specified, will not react to thefts in the village.

@@ 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 Personalities, these are found in .villager files and contains information for;