Festivals - Revision history

MarkGrant: /* "notify" */

2020-11-03T20:26:40Z

‎"notify"

MarkGrant: /* "outfit" */

2020-11-03T18:49:41Z

‎"outfit"

MarkGrant at 18:48, 3 November 2020

2020-11-03T18:48:05Z

MarkGrant: /* "hosts" */

2020-11-03T18:39:59Z

‎"hosts"

DeamonHunter: Update with newer 1.3 values.

2018-09-12T08:43:51Z

Update with newer 1.3 values.

DeamonHunter: Some Renames to Variables.

2018-02-06T12:31:06Z

Some Renames to Variables.

DeamonHunter: Updated to new section

2017-12-05T10:09:48Z

Updated to new section

DeamonHunter: Initial Commit.

2017-11-24T05:35:32Z

Initial Commit.

New page

[[Category:Modding]]
In Staxel, *.festival files are used to specify a new festival in the game. It provides the backbone of all the different NPC's and structures that are needed for creating festivals. Festivals include ways to;

* Override existing NPC's and structures
* Add in new NPC's for the festival.
* Sell new products at shops.

= Creating a *.festival file =

Tutorial will come later. This requires following [[Structures]] tutorials as well as [[Villager NPCs]] tutorials. Also includes [[Treasure Pools]] for selling more items and [[Weather]] which can also dictate [[Gatherable Component]] Spawning. Most of all of this is optional.

= Config Options =
== "code" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which identifies what Festival this is.</code>'''

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

This option is required to uniquely identify any Festival. This string '''must''' be unique to all other codes, but does not have any other requirements.

== "festivalTotem" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Totems|Totem]] code.</code>'''

'''Default Value:''' If not specified, villagers will not hang around any totem.

Only used when the script "staxel.script.ChillAtFestivalTotem" is used. This is the totem that is used for NPC's to go to and hang out during the festival.

== "generalVillagerOverride" ==
This is a singular [[Modding_Key_Terms#Blob|Blob]] which contains information on what things about every villager should be replaced. This contains the exact same properties as [[#"villagerOverrides"]], except the name is not considered.

== "requiredTotems" ==
'''''This is currently not implemented'''''

This is a [[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]. This contains information on what Totems should be existing before the Festival can occur. This is normally constructed like;

<pre>
"totemReplacements" : [
{
"totem" : "staxel.totem.workplace.TownSquare",
"structure" : "staxel.structure.village.festival.PumpkingFeastTownSquare"
},
{
"totem" : "staxel.totem.workplace.FestivalSquare",
"structure" : "staxel.structure.village.festival.PumpkingFeastMaze"
}
],
</pre>

=== "totem" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Totems|Totem]] code.</code>'''

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

This is the totem that is to be replaced by the structure.

=== "structure" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Structures|Structure]] code.</code>'''

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

This is the structure that will replace the totem.

== "hosts" ==
This is a [[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]. This contains information on new villagers that will appear for the festival. This is normally constructed like;

<pre>
"hosts" : [
{
"name" : "Caren",
"code" : "staxel.village.character.festival.Caren"
},
{
"name" : "Ami",
"code" : "staxel.village.character.festival.Ami"
}
]
</pre>

=== "name" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string.</code>'''

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

The name of the host being spawned.

=== "code" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Villager NPCs|Villager NPC]] code.</code>'''

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

This is the villager definition that will get used to spawn the villager. The villager will use the name above though.

=== "independentSpawn" ===
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

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

This determines if the host will be spawned normally (False), or they will have to be spawned by other means. (True)

=== "outfit" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Villager Designs|Villager Design]] code.</code>'''

'''Default Value:''' If not specified, will not spawn the NPC with an additional outfit.

This will be the outfit that the NPC will wear through the Festival. Not worn when the NPC appears outside of Festival Times. (The day before or after the festival.)

== "season" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>"Summer", "Autumn", "Winter", "Spring"</code>'''

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

This is the season that the festival will be in. Festivals cannot go across seasons.

== "shops" ==
'''''This is currently not implemented'''''

This is a [[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]. This contains information on what Totems should get new items. This is normally constructed like;

<pre>
"totemReplacements" : [
{
"totem" : "staxel.totem.workplace.TownSquare",
"treasure" : "staxel.treasure.SeasonalFunStuff"
},
{
"totem" : "staxel.totem.workplace.FestivalSquare",
"treasure" : "",
"seasonalItems" : [
{
"code": "staxel.item.snowball"
}
]
}
],
</pre>

=== "totem" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Totems|Totem]] code.</code>'''

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

This is the totem that is to be replaced by the structure.

=== "seasonalItems" ===
'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]): <code>A list of blobs containing [[Items]]. See [[Items#Universal Spawning Rules]] for more details.</code>'''

'''Default Value:''' If not specified, will not hold any items during the job.

List of additional items that will be added to the totem.

=== "treasure" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Treasure Pools|Treasure Pool]] code.</code>'''

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

This is the structure that will replace the totem.

== "start"/"end" ==
'''Valid options ([[Modding_Key_Terms#Integer|Integer]]): <code>A positive integer number.</code>'''

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

This is the value for when the first and last day of the festival happens.

== "totemReplacements" ==
This is a [[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]. This contains information on what Totems should be replaced with structures upon the festival starting. THis is normally constructed like;

<pre>
"totemReplacements" : [
{
"totem" : "staxel.totem.workplace.TownSquare",
"structure" : "staxel.structure.village.festival.PumpkingFeastTownSquare"
},
{
"totem" : "staxel.totem.workplace.FestivalSquare",
"structure" : "staxel.structure.village.festival.PumpkingFeastMaze"
}
],
</pre>

=== "totem" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Totems|Totem]] code.</code>'''

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

This is the totem that is to be replaced by the structure.

=== "structure" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Structures|Structure]] code.</code>'''

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

This is the structure that will replace the totem.

== "villagerOverrides" ==
This is a [[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]. This contains information on what things about specific villagers will be replaced.

<pre>
"villagerOverrides" : [
{
"villager" : "Riah",
"primaryDialogue" : "staxel.village.character.dialogue.festival.RiahPumpkingFeast",
"suppressPersonality" : true,
"suppressJob" : true,
"festivalBehaviour" : [
{
"script" : "staxel.script.ChillAtTavernScript",
"weight" : 10.0
}
]
}
]
</pre>

=== "villager" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains the name of a [[Villager NPCs|Villager NPC]].</code>'''

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

This is the villager that will have aspects of them replaced.

=== "dialoguePools" ===
'''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:''' If not specified, will not have any dialogue.

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. This replaces the original [[Villager NPCs#"dialoguePools"]]

=== "primaryDialogue" ===
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Dialogue]].</code>'''

'''Default Value:''' If not specified, will not force a certain dialogue to appear first.

This specifies a dialogue which must be played first before all other dialogues. Useful for when something should be done first before all else. This replaces the original [[Villager NPCs#"primaryDialogue"]]

=== "suppressPersonality" ===
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

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

This makes it so features such as general dialogue do not play for this villager.

=== "suppressJob" ===
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

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

This makes it so the job does not interfere with the

=== "festivalBehaviour" ===
This is a [[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blobs|Blobs]] that contain properties for weighting scripts. These scripts involve how the villager should act, and the weight specifies how likely the particular script will be gotten compared to the others. These are used to replace the usual scripts surrounding villagers. These blobs look like;

<pre>
{
"script": "staxel.script.StandAroundIdle",
"weight": 25.0
}
</pre>

==== "script" ====
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that points to a [[Script]].</code>'''

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

This specifies which script to use.

==== "weight" ====
'''Valid options ([[Modding_Key_Terms#Double|Double]]): <code>A positive decimal number.</code>'''

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

The weight this script will have compared to other scripts.

== "weather" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Weather]] code.</code>'''

'''Default Value:''' If not specified, will continue with normal weather.

This is the weather that will get played during the entirety of the festival.

@@ Line 39: / Line 39: @@
-=== "icon" ===
+== "icon" ==
 '''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the path to an image file.</code>'''
@@ Line 46: / Line 46: @@
 This is an image that will show up on the festival calendar dates.
 == "festivalTotem" ==

@@ Line 312: / Line 312: @@
-This will change the villager's outfit during the festival.
+This will be the outfit that the NPC will wear through the Festival. Not worn when the NPC appears outside of Festival Times. (The day before or after the festival.)
-−
 === "festivalDialoguePools" ===

@@ Line 28: / Line 28: @@
 This determines whether or not the festival can only be called as part of a Villager Quest. Bypasses the [[#"start"/"end"|start and end]] properties as well as the [[#"season"|season]] property.
@@ Line 109: / Line 127: @@
 This is the villager definition that will get used to spawn the villager. The villager will use the name above though.
@@ Line 163: / Line 172: @@
 This is the tile that the villager will attempt to move towards, if [[#"moveImmediatelyToTotem"|moveImmediatelyToTotem]] was set to true.
 == "season" ==
@@ Line 294: / Line 304: @@
 This is the villager that will have aspects of them replaced.

@@ Line 109: / Line 109: @@
 This is the villager definition that will get used to spawn the villager. The villager will use the name above though.
@@ Line 154: / Line 163: @@
 This is the tile that the villager will attempt to move towards, if [[#"moveImmediatelyToTotem"|moveImmediatelyToTotem]] was set to true.
 == "season" ==

← Older revision		Revision as of 08:43, 12 September 2018
Line 19:		Line 19:

	This option is required to uniquely identify any Festival. This string '''must''' be unique to all other codes, but does not have any other requirements.		This option is required to uniquely identify any Festival. This string '''must''' be unique to all other codes, but does not have any other requirements.
		+
		+
		+	== "quest" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''Default Value:''' If not specified defaults to False.
		+
		+
		+	This determines whether or not the festival can only be called as part of a Villager Quest. Bypasses the [[#"start"/"end"\|start and end]] properties as well as the [[#"season"\|season]] property.


Line 118:		Line 127:

	This will be the outfit that the NPC will wear through the Festival. Not worn when the NPC appears outside of Festival Times. (The day before or after the festival.)		This will be the outfit that the NPC will wear through the Festival. Not worn when the NPC appears outside of Festival Times. (The day before or after the festival.)
		+
		+
		+	=== "moveImmediatelyToTotem" ===
		+	'''Valid options ([[Modding_Key_Terms#String\|String]]): <code>Any valid string which contains a [[Totems\|Totem]] code.</code>'''
		+
		+	'''Default Value:''' If not specified, will not attempt to move the host to the totem.
		+
		+
		+	The totem in which the host will attempt to move to at festival start. This is mostly applicable to Quest Totems, as these can start in the middle of the day. Normal hosts will spawn in the totem area already.
		+
		+
		+	=== "refuseNightTeleport" ===
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''Default Value:''' If not specified, will default to False.
		+
		+
		+	This determines if the host will refuse to teleport home as of a night. Only applicable if the host is a normal villager.
		+
		+
		+	=== "tileToMoveTo" ===
		+	'''Valid options ([[Modding_Key_Terms#String\|String]]): <code>Any valid string which contains a [[Tile]] code.</code>'''
		+
		+	'''Default Value:''' If left empty, the villager will try to move towards something in the Totem specified in [[#"moveImmediatelyToTotem"\|moveImmediatelyToTotem]]
		+
		+
		+	This is the tile that the villager will attempt to move towards, if [[#"moveImmediatelyToTotem"\|moveImmediatelyToTotem]] was set to true.

@@ Line 252: / Line 252: @@
-=== "dialoguePools" ===
+=== "festivalDialoguePools" ===
 '''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>'''
@@ Line 315: / Line 315: @@
-== "weather" ==
+== "weatherOverride" ==
 '''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains a [[Weather]] code.</code>'''

@@ Line 162: / Line 162: @@
 === "seasonalItems" ===
-'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]): <code>A list of blobs containing [[Items]]. See [[Items#Universal Spawning Rules]] for more details.</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#Blob|Blobs]]): <code>A list of blobs containing [[Items]]. See [[Items#How to Spawn an Item]] for more details.</code>'''
 '''Default Value:''' If not specified, will not hold any items during the job.