Revision as of 04:23, 31 May 2017

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.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
}

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): Any valid string that leads to an item.

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): A string that represents the path to the 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.

"playable"

Valid options (List of strings): A list of strings that contain particle codes.

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;

"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): A string that represents the path to the 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 string which points to an Body Type 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): A string which contains a path which points to a model file

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 containing the codes of Palettes that can colour the model

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?