Villager Designs - Revision history

DeamonHunter: Formatting

2018-01-09T12:03:02Z

Formatting

DeamonHunter: Oops.

2018-01-02T10:38:23Z

Oops.

DeamonHunter: Fix redlink

2018-01-01T12:10:58Z

Fix redlink

DeamonHunter: Change the tutorial to be more useful.

2018-01-01T12:09:40Z

Change the tutorial to be more useful.

DeamonHunter: Update formatting.

2017-11-17T07:31:21Z

Update formatting.

DeamonHunter: Updated to new category.

2017-07-08T06:52:58Z

Updated to new category.

DeamonHunter: Copy Paste errors.

2017-07-08T06:10:05Z

Copy Paste errors.

DeamonHunter: Initial commit.

2017-06-13T11:25:39Z

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

* The species, gender and personality of the villager
* The Hair style, eye type and the model of the villager
* Which hand is the dominant hand

As a note, this file does not specify all of villagers looks, particularly the villagers clothes, but it does specify the majority of the physical traits for a villager.

This page will mainly focus on [[#_version|Version 3]]. This is the latest version of the design file. Staxel is made with keeping backwards compatibility in mind, which includes keeping saves at least partially workable between updates.

= Creating a *.characterdesign file =
Creating a character design file is mostly collecting other files together into a singular file. This file is then used in a [[Villager NPCs|.villagernpc]] villager files. The file commonly looks like:
<pre>
{
"code": "mods.modname.villager.design.charactername",
"design": {
"_version": 3,
"Species": "staxel.species.Elf",
"Gender": "female",
"Personality": "staxel.personality.feminine",
"LeftHanded": false,
"Model": {
"model": "staxel/characters/species/elf/Elf_Female.qb",
"palette": "staxel.palette.skin.fair"
},
"Hair": {
"model": "staxel.accessories.hairstyles.female.long.curlyhairbands.CurlyYellowHairbands",
"palette": "staxel.palette.blonde"
},
"Eyes": {
"model": "staxel.accessories.eyes.kawaiiEyelashes",
"palette": "staxel.palette.blue"
},
"revision": 0
}
}
</pre>

First thing to note is that most properties are actually included in "design". Keep that in mind when editing so that you do not run into issues. Most properties point towards the code of other files, such as many of the models pointing towards an [Accessory|Accessory's Code].

Keep revision at 0 unless you are updating characters inside of worlds. All other values are specified in the config options section. With all of this done, your villager has their look definied and you could

= Config Options =

== "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.

== "design" ==
Unlike most other files, the majority of data is actually specified in this property rather than the overall file. This property will generally look like;
<pre>
"design": {
"_version": 3,
"Species": "staxel.species.Elf",
"Gender": "female",
"Personality": "staxel.personality.feminine",
"LeftHanded": false,
"Model": {
"model": "staxel/characters/species/elf/Elf_Female.qb",
"palette": "staxel.palette.skin.fair"
},
"Hair": {
"model": "staxel.accessories.hairstyles.female.long.curlyhairbands.CurlyYellowHairbands",
"palette": "staxel.palette.blonde"
},
"Eyes": {
"model": "staxel.accessories.eyes.kawaiiEyelashes",
"palette": "staxel.palette.blue"
},
revision": 1
}
</pre>
These properties are listed below.

=== "_version" ===
'''Valid options (Int): <code>An integer which corresponds to the version of the file. Currently Version 3 is the latest.</code>'''

'''Default Value:''' 1 (Not recommended to skip. As it leads to an older version.)

This is the version number which specifies how the file should be interpreted. This is mainly to keep old worlds from crashing due to missing information. For example, version 1 had "Model"/"Hair"/"Eyes" be a singular string for model rather than the combined model and palette listed below. It's recommended to use the latest version when creating new files.

=== "LeftHanded" ===
'''Valid options (Bool): <code>Either false or true</code>'''

'''Default Value:''' False (Can be Omitted)

This determines whether the villager uses tools in their right hand or their left. The default is the right hand.

=== "Gender" ===
'''Valid options (String): <code>Either "Male" or "Female".</code>'''

'''Default Value:''' No default value. Must be specified.

This is the gender of the villager. This is mainly used in order to apply the correct [[Body Type]] to the model specified.

=== "Model"/"Hair"/"Eyes" ===
All three of these properties contain two values which aim to specify what accessory/model is meant to be in this place. None of these options are normally changed during gameplay (As opposed to clothing which may be changed.) These properties look like;
<pre>
"Eyes": {
"model": "staxel.accessories.eyes.kawaiiEyelashes",
"palette": "staxel.palette.blue"
},
</pre>

The properties inside of this can actually be omitted without trouble but this property (Model/Hair/Eyes) must exist.

==== "model" ====
'''Valid options (String): <code>Either the code of an [[Accessory]] file or the path to a model file.</code>'''

'''Default Value:''' "" (Can be omitted)

This is the model to use for this section. The Accessory Code is the method that should be used for Eyes and Hair but the path should be used for models. (As these models generally don't have files associated with them.)

==== "palette" ====
'''Valid options (String): <code>The code of an [[Palettes|Pallete]] file.</code>'''

'''Default Value:''' "" (Can be omitted)

This is the colouring to use for this section.

=== "Personality" ===
'''Valid options (String): <code>The code of an [[Personalty]] file.</code>'''

'''Default Value:''' "" (Can be omitted)

This points to what animation personality will be used for this model.

=== "Species" ===
'''Valid options (String): <code>The code of an [[Species]] file</code>'''

'''Default Value:''' No default value. Must be specified.

This is the species of the villager. This is mainly used in order to apply the correct [[Body Type]] to the model specified.

=== "revision" ===
'''Valid options (Int): <code>The number determining what version the person is</code>'''

'''Default Value:''' No default value. Must be specified.

This is used to differentiate different versions of the same character and is mainly responsible for making sure the client and server are running the same version of the character.

← Older revision		Revision as of 12:03, 9 January 2018
Line 102:		Line 102:


−	After you have done editing the file, head to gamedata/bin/ folder, and start up Staxel.ContentBuilder.exe. When this has started up, click Validate Resources 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.	+	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.

@@ Line 19: / Line 19: @@
 == Adding the Villager Design 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.
+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]]

@@ Line 99: / Line 99: @@
 ** For "Model", A [[Modding_Key_Terms#String|String]] that is the path to the model you want to use. This will be the model that will be the body for the NPC. This starts at the <code>/content/</code> directory and therefore will mostly start with <code>mods/modname/</code>.
 ** For "Hair" or "Eyes", A [[Modding_Key_Terms#String|String]] that is the code of the [[Accessory]] you want to use. This will be the Accessory that will be the Hair or Eyes of the NPC.
-* [[#"palette"|"palette"]]: A [[Modding_Key_Terms#String|String]] that is the code of the [[Pallete]] you want to use to colour the model. This is how different skin and hair colours are done. You can leave this blank in order to get the default palette.
+* [[#"palette"|"palette"]]: A [[Modding_Key_Terms#String|String]] that is the code of the [[Palletes|Pallete]] you want to use to colour the model. This is how different skin and hair colours are done. You can leave this blank in order to get the default palette.

@@ Line 14: / Line 14: @@
 = Creating a *.characterdesign file =
-Creating a character design file is mostly collecting other files together into a singular file. This file is then used in a [[Villager NPCs|.villagernpc]] villager files. The file commonly looks like:
+Character design files are heavily dependent on a couple things; [[Species]], [[Personalities]] and [[Accessory|Accessories]]. As such, you can look at these pages to see how to create these individual things. You will learn where they belong later in the tutorial however.
 <pre>
+{
-   "code": "mods.modname.villager.design.charactername",
+   "code": "mods.modnamehere.villager.design.villagername",
    "design": {
      "_version": 3,
@@ Line 26: / Line 61: @@
      "Model": {
        "model": "staxel/characters/species/elf/Elf_Female.qb",
-       "palette": "staxel.palette.skin.fair"
+       "palette": "staxel.palette.skin.oriental"
      },
      "Hair": {
-       "model": "staxel.accessories.hairstyles.female.long.curlyhairbands.CurlyYellowHairbands",
+       "model": "staxel.accessories.devavatars.razz.RazzHair",
-       "palette": "staxel.palette.blonde"
+       "palette": ""
      },
      "Eyes": {
-       "model": "staxel.accessories.eyes.kawaiiEyelashes",
+       "model": "staxel.accessories.eyes.normal",
-       "palette": "staxel.palette.blue"
+       "palette": "staxel.palette.pink"
      },
      "revision": 0
@@ Line 41: / Line 76: @@
 </pre>
-First thing to note is that most properties are actually included in "design". Keep that in mind when editing so that you do not run into issues. Most properties point towards the code of other files, such as many of the models pointing towards an [Accessory|Accessory's Code].
+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.
-Keep revision at 0 unless you are updating characters inside of worlds. All other values are specified in the config options section. With all of this done, your villager has their look definied and you could
+After you have done editing the file, head to gamedata/bin/ folder, and start up Staxel.ContentBuilder.exe. When this has started up, click Validate Resources 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.

@@ Line 49: / Line 49: @@
 == "code" ==
-'''Valid options (String): <code>A unique string which design this object is.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which design this object is.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 85: / Line 85: @@
 === "_version" ===
-'''Valid options (Int): <code>An integer which corresponds to the version of the file. Currently Version 3 is the latest.</code>'''
+'''Valid options ([[Modding_Key_Terms#Integer|Integer]]): <code>An integer which corresponds to the version of the file. Currently Version 3 is the latest.</code>'''
-'''Default Value:''' 1 (Not recommended to skip. As it leads to an older version.)
+'''Default Value:''' If not specified, will default to 1. (Not recommended to skip. As it leads to an older version.)
@@ Line 94: / Line 94: @@
 === "LeftHanded" ===
-'''Valid options (Bool): <code>Either false or true</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>False or True.</code>'''
-'''Default Value:''' False (Can be Omitted)
+'''Default Value:''' If not specified, will default to false.
@@ Line 103: / Line 103: @@
 === "Gender" ===
-'''Valid options (String): <code>Either "Male" or "Female".</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Either "Male" or "Female".</code>'''
-'''Default Value:''' No default value. Must be specified.
+'''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 123: / Line 123: @@
 ==== "model" ====
-'''Valid options (String): <code>Either the code of an [[Accessory]] file or the path to a model file.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Either the code of an [[Accessory]] file or the path to a model file.</code>'''
-'''Default Value:''' "" (Can be omitted)
+'''Default Value:''' If not specified, will default to no model.
@@ Line 132: / Line 132: @@
 ==== "palette" ====
-'''Valid options (String): <code>The code of an [[Palettes|Pallete]] file.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>The code of an [[Palettes|Pallete]] file.</code>'''
-'''Default Value:''' "" (Can be omitted)
+'''Default Value:''' If not specified, will default to the default palette.
@@ Line 141: / Line 141: @@
 === "Personality" ===
-'''Valid options (String): <code>The code of an [[Personalty]] file.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>The code of an [[Personalty]] file.</code>'''
-'''Default Value:''' "" (Can be omitted)
+'''Default Value:''' If not specified, will default to no personality.
@@ Line 150: / Line 150: @@
 === "Species" ===
-'''Valid options (String): <code>The code of an [[Species]] file</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>The code of an [[Species]] file</code>'''
-'''Default Value:''' No default value. Must be specified.
+'''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 159: / Line 159: @@
 === "revision" ===
-'''Valid options (Int): <code>The number determining what version the person is</code>'''
+'''Valid options ([[Modding_Key_Terms#Integer|Integer]]): <code>The number determining what version the person is</code>'''
-'''Default Value:''' No default value. Must be specified.
+'''Default Value:''' No default value is specified. Always need to provide your own.
 This is used to differentiate different versions of the same character and is mainly responsible for making sure the client and server are running the same version of the character.

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