Latest revision as of 08:45, 19 July 2018

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;

{
  "code" : "mods.modname.species",
  "icon" : "mods/modname/speciesIcon.png",
  "male" : {
    "icon" : "mods/modname/maleSpeciesIcon.png",
    "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",
      "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
}

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): A unique string which identifies what Accessory this is.

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

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): Any valid string which contains the path to an image.

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 in the character creator.

"male"/"female"

These are both 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.);

"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" ]
}

"icon"

Valid options (String): Any valid string which contains the path to a image.

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): A strings containing the code to a Body Type.

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): Any valid string which contains the path to a model.

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): A list of strings each pointing to a separate Palettes.

Default Value: If not specified, will not have any palettes and will rely on the model's colours.

This is a list of colour swaps for this model.

"paletteGroups"

Valid options (List of Strings): A list of strings each pointing to a separate Palette Group.

Default Value: If not specified, will not have any palettes and will rely on the model's colours.

This is a list of Palette groups which contain a number of colour swaps for this model.

"playable"

Valid options (Bool): True or False

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

Determines whether or not this species can be played by the player.