Species - Revision history

Callum: Fixed typo

2018-07-19T13:45:27Z

Fixed typo

DeamonHunter: Update properties.

2017-10-10T08:39:27Z

Update properties.

DeamonHunter: Oops.

2017-05-31T10:05:19Z

Oops.

DeamonHunter: Forgot a bracket

2017-05-31T09:53:25Z

Forgot a bracket

DeamonHunter: Initial commit.

2017-05-31T09:23:29Z

Initial commit.

New page

[[Category:Modding]]
In Staxel, *.species files are used to specify a character race or animal's looks. Species files provide the backbone for providing the looks of many of the living things in Staxel. They contain references on how to create two different types, usually "masculine" and "feminine" body. These bodies include;

* The [[Body Type]] that the model will be.
* The model and it's [[Palettes]] that it will use.
* An icon to show if needed. (Such as for character select.)

= Creating a *.species file =

A species file is mostly full of references to other files which provide the more basic information. The common layout of a species file looks like;
<pre>
"code" : "mods.modname.species",
"icon" : "mods/modname/speciesIcon.png",
"male" : {
"icon" : "mods/modname/maleSpeciesIcon.png",
"bodyType" : "mods.modname.femalebodytype",
"model" : "mods/modname/species_Male.qb",
"palettes" : [ "staxel.palette.skin.fair", "staxel.palette.skin.slightTan", "staxel.palette.skin.tanned", "staxel.palette.skin.tropical",
"staxel.palette.skin.dark", "staxel.palette.skin.darker", "staxel.palette.skin.oriental" ]
},
"female" : {
"icon" : "mods/modname/femaleSpeciesIcon.png",
"bodyType" : "mods.modname.femalebodytype",
"model" : "mods/modname/species_Female.qb",
"palettes" : [ "staxel.palette.skin.fair", "staxel.palette.skin.slightTan", "staxel.palette.skin.tanned", "staxel.palette.skin.tropical",
"staxel.palette.skin.dark", "staxel.palette.skin.darker", "staxel.palette.skin.oriental" ]
},
"playable" : true
}
</pre>

All icon properties must point to images. The models must point to a *.qb or [[.layered]] file and [[BodyType]] and [[Palettes]] include a code that points to another file. After this is all created, your species is now ready to be used in Staxel.

= Config Options =
== "code" ==
'''Valid options (String): <code>Any valid string that leads to an item.</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.

== "icon" ==
'''Valid options (String): <code>A string that represents the path to the image.</code>'''

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

A string which contains the path to the image which should be displayed for the species.

== "playable" ==
'''Valid options (List of strings): <code>A list of strings that contain particle codes.</code>'''

'''Default Value:''' False. (Not playable)

A bool value which determines whether or not a player can play with this race.

== "male"/"female" ==
These contain information for the individual genders of a species. They are normally constructed like;

<pre>
"male" : {
"icon" : "mods/modname/maleSpeciesIcon.png",
"bodyType" : "mods.modname.femalebodytype",
"model" : "mods/modname/species_Male.qb",
"palettes" : [ "staxel.palette.skin.fair", "staxel.palette.skin.slightTan", "staxel.palette.skin.tanned", "staxel.palette.skin.tropical",
"staxel.palette.skin.dark", "staxel.palette.skin.darker", "staxel.palette.skin.oriental" ]
}
</pre>

=== "icon" ===
'''Valid options (String): <code>A string that represents the path to the image.</code>'''

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

A string which contains the path to the image which should be displayed for the particular gender.

=== "bodytype" ===
'''Valid options (String): <code>A string which points to an [[Body Type]] code</code>'''

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

This defines the Body Type that the model will use. Body Types include the information on animations and model layers that are needed for movement.

=== "model" ===
'''Valid options (String): <code>A string which contains a path which points to a model file</code>'''

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

This defines the model that this particular gender will use. There is no restriction on what model is used, although the Body Type must be able to support it.

=== "palettes" ===
'''Valid options (List of Strings): <code>A list of strings containing the codes of [[Palettes]] that can colour the model</code>'''

'''Default Value:''' No default value however false is taken as default in base effect config.

These palettes are used to allow different skin colours in the models. Mostly used in junction with playable characters in order to allow players to choose.
This boolean value specifies whether or not this effect will be offset when used on a tile with a tile State?

@@ Line 16: / Line 16: @@
    "male" : {
      "icon" : "mods/modname/maleSpeciesIcon.png",
-     "bodyType" : "mods.modname.femalebodytype",
+     "bodyType" : "mods.modname.malebodytype",
      "model" : "mods/modname/species_Male.qb",
      "palettes" : [ "staxel.palette.skin.fair", "staxel.palette.skin.slightTan", "staxel.palette.skin.tanned", "staxel.palette.skin.tropical",

@@ Line 36: / Line 36: @@
 = Config Options =
 == "code" ==
-'''Valid options (String): <code>A unique string which species what this object is.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which identifies what Accessory this 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.
+This option is required to uniquely identify any Accessory. This string '''must''' be unique to all other codes, but does not have any other requirements.
 == "icon" ==
-'''Valid options (String): <code>A string that represents the path to the image.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains the path to an image.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
-A string which contains the path to the image which should be displayed for the species.
+A string which contains the path to the image which should be displayed for the species in the character creator.
-−
-−
-== "playable" ==
-'''Valid options (List of strings): <code>A list of strings that contain particle codes.</code>'''
-−
-'''Default Value:''' False. (Not playable)
-−
-−
-A bool value which determines whether or not a player can play with this race.
 == "male"/"female" ==
-These contain information for the individual genders of a species. They are normally constructed like;
+These are both [[Modding_Key_Terms#Blob|Blobs]]. Both of these contain information for the individual genders of a species. These are normally constructed like. (Swap "male" for "female" to change the female version.);
 <pre>
@@ Line 74: / Line 65: @@
+}
 </pre>
 === "icon" ===
-'''Valid options (String): <code>A string that represents the path to the image.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains the path to a image.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 85: / Line 75: @@
-=== "bodytype" ===
+=== "bodyType" ===
-'''Valid options (String): <code>A string which points to an [[Body Type]] code</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A strings containing the code to a [[Body Type]].</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 95: / Line 85: @@
 === "model" ===
-'''Valid options (String): <code>A string which contains a path which points to a model file</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Any valid string which contains the path to a model.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 104: / Line 94: @@
 === "palettes" ===
-'''Valid options (List of Strings): <code>A list of strings containing the codes of [[Palettes]] that can colour the model</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|Strings]]): <code>A list of strings each pointing to a separate [[Palettes]].</code>'''
-These palettes are used to allow different skin colours in the models. Mostly used in junction with playable characters in order to allow players to choose.
+Determines whether or not this species can be played by the player.
-This boolean value specifies whether or not this effect will be offset when used on a tile with a tile State?

@@ Line 11: / Line 11: @@
 A species file is mostly full of references to other files which provide the more basic information. The common layout of a species file looks like;
 <pre>
    "code" : "mods.modname.species",
    "icon" : "mods/modname/speciesIcon.png",
@@ Line 32: / Line 33: @@
 All icon properties must point to images. The models must point to a *.qb or [[.layered]] file and [[BodyType]] and [[Palettes]] include a code that points to another file. After this is all created, your species is now ready to be used in Staxel.
 = Config Options =