Species Documentation - Revision history

Little meow meow: incomplete formatting fixes

2025-09-09T09:21:44Z

incomplete formatting fixes

← Older revision		Revision as of 09:21, 9 September 2025
Line 1:		Line 1:
	~~== How A Species Is Made ==~~		This page documents how new species are created.
	''When a mommy coder and a daddy spriter love each other very much...''
	==== The .YML Files ====		<blockquote>''When a mommy coder and a daddy spriter love each other very much...''</blockquote>
	~~'''~~Resources/Prototypes/(_namespace)/Species/[species].yml~~'''~~
	<br>		== The .YML Files ==
	This file contains the ~~'''~~species~~'''~~ prototype, which contains some of the information needed for the character creation menu. This includes...		<code>Resources/Prototypes/(_namespace)/Species/[species].yml</code>

			This file contains the <code>species</code> prototype, which contains some of the information needed for the character creation menu. This includes...
	* '''id''' (recommended): the internal name of the prototype, which is generally just the species name.		* '''id''' (recommended): the internal name of the prototype, which is generally just the species name.
	* '''name''' (required): the user-facing name of the species; point this to a locale string.		* '''name''' (required): the user-facing name of the species; point this to a locale string.

Little meow meow: Little meow meow moved page /w/Species Documentation to Species Documentation without leaving a redirect: Misspelled title

2025-09-09T09:15:28Z

Little meow meow moved page /w/Species Documentation to Species Documentation without leaving a redirect: Misspelled title

← Older revision	Revision as of 09:15, 9 September 2025
(No difference)

Skcb: Skcb moved page Dev:SpeciesDocumentation to /w/Species Documentation

2025-09-09T08:52:46Z

Skcb moved page Dev:SpeciesDocumentation to /w/Species Documentation

← Older revision	Revision as of 08:52, 9 September 2025
(No difference)

Skcb at 08:51, 9 September 2025

2025-09-09T08:51:55Z

← Older revision		Revision as of 08:51, 9 September 2025
Line 51:		Line 51:
	<br>		<br>
	Species-specific sprite parts are defined with a '''humanoidBaseSprite''' prototype. These simply have a single component, '''baseSprite''', containing the '''sprite:''' [path_to_parts.rsi] and '''state:''' [body_part].		Species-specific sprite parts are defined with a '''humanoidBaseSprite''' prototype. These simply have a single component, '''baseSprite''', containing the '''sprite:''' [path_to_parts.rsi] and '''state:''' [body_part].
			[[Category:Development]]

Skcb: Adding info about the baseSprites prototype

2025-09-08T23:34:54Z

Adding info about the baseSprites prototype

@@ Line 5: / Line 5: @@
 <br>
 This file contains the '''species''' prototype, which contains some of the information needed for the character creation menu. This includes...
-* '''id''' (recommended): the internal name of the prototype.
+* '''id''' (recommended): the internal name of the prototype, which is generally just the species name.
 * '''name''' (required): the user-facing name of the species; point this to a locale string.
 * '''roundStart''' (required): whether the species is available at roundstart, IE the character creation menu in the lobby.
 * '''prototype''' (required): what mob prototype the player entity will inherit the features of. defined elsewhere (see below).
 * '''dollPrototype''' (required): what mob prototype will be used in certain menus, such as the character creator. defined elsewhere (see below).
-* '''sprites''': the sprite prototype that makes up the player entity. defined in this
+* '''sprites''': the sprite prototype that makes up the player entity. defined in this file (see below).
 * '''markingLimits''': the marking limit prototype that sets how many markings and what kind the species can have. defined in this file.
 * '''dollPrototype''' (required): what mob prototype will be used in certain menus, such as the character creator. defined elsewhere (see below).
@@ Line 24: / Line 24: @@
 * '''defaultHeight''', '''defaultWidth''': float numbers which define the starting scale factor for a character's height and width (obviously). both default to '''1'''. these are applied as a modifier to the '''baseScale''', above (I think).
 * '''scaleHeight''', '''scaleWidth''': boolean. whether the character is scaled vertically or horizontally (respectively). both default to '''true'''. you probably shouldn't change these.

Skcb: A best-effort documentation of how new playable species are constructed in SS14, specifically under the starcup codebase.

2025-09-08T23:11:07Z

A best-effort documentation of how new playable species are constructed in SS14, specifically under the starcup codebase.

New page

== How A Species Is Made ==
''When a mommy coder and a daddy spriter love each other very much...''
==== The .YML Files ====
'''Resources/Prototypes/(_namespace)/Species/[species].yml'''
<br>
This file contains the '''species''' prototype, which contains some of the information needed for the character creation menu. This includes...
* '''id''' (recommended): the internal name of the prototype.
* '''name''' (required): the user-facing name of the species; point this to a locale string.
* '''roundStart''' (required): whether the species is available at roundstart, IE the character creation menu in the lobby.
* '''prototype''' (required): what mob prototype the player entity will inherit the features of. defined elsewhere (see below).
* '''dollPrototype''' (required): what mob prototype will be used in certain menus, such as the character creator. defined elsewhere (see below).
* '''sprites''': the sprite prototype that makes up the player entity. defined in this
* '''markingLimits''': the marking limit prototype that sets how many markings and what kind the species can have. defined in this file.
* '''dollPrototype''' (required): what mob prototype will be used in certain menus, such as the character creator. defined elsewhere (see below).
* '''skinColoration''' (required): which method of skin coloration is used. existing options include: HumanToned, Hues, TintedHues, & VoxFeathers.
* '''defaultSkinTone''': default skin tone for species with a non-HumanToned skin coloration. defaults to white.
* '''defaultHumanSkinTone''': default skin tone for species with HumanToned skin coloration. defaults to '''20''', on a scale from '''0''' (gold/yellow) to '''100''' (dark brown).
* '''maleFirstNames''', '''femaleFirstNames''', '''lastNames''', (etc): namelist prototypes to reference for different name components. defaults to the basic human namelist.
* '''naming''': the naming rules for the random name generator. defaults to FirstLast. other existing options include: First, LastNoFirst, TheFirstOfLast, FirstDashFirst, LastFirst, FirstDashLast, & FirstCodeLast.
* '''sexes''': a list of valid sexes for the species to be. this can include some combination of Male, Female, and Unsexed.
* '''minAge''', '''youngAge''', '''oldAge''', '''maxAge''': these integers define breakpoints for this species age. '''minAge''' is the youngest a character of this species can be, and is implied to be an "age of majority". '''youngAge''' and '''oldAge''' define whether a character is described as young (under '''youngAge'''), middle-aged ('''youngAge''' to '''oldAge'''), or old (over '''oldAge'''). '''maxAge''' is the oldest a character of this species can be, and is implied to be a "maximum reasonable lifespan". in order, these default to '''18''', '''30''', '''60''', and '''120'''.
* '''baseScale''': this takes two float numbers, which are applied as modifiers to the character's sprite scaling in X and Y (i think) respectively. defaults to '''1, 1'''.
* '''minHeight''', '''maxHeight''': float numbers which define the minimum and maximum heights a character can be set to in the character creator. defaults to '''0.95''' and '''1.05''', respectively (at least in starcup). these are applied as a modifier to the '''baseScale''', above (I think).
* '''defaultHeight''', '''defaultWidth''': float numbers which define the starting scale factor for a character's height and width (obviously). both default to '''1'''. these are applied as a modifier to the '''baseScale''', above (I think).
* '''scaleHeight''', '''scaleWidth''': boolean. whether the character is scaled vertically or horizontally (respectively). both default to '''true'''. you probably shouldn't change these.