optolith/database-schema
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f865a340588fbc0a1d0c42b078b92412ea7dfc61
database-schema/docs/reference/Race.md
T

25 KiB
Raw Blame History

Race

A playable race with stats and skills.

Definitions

Race (Race)

A playable race with stats and skills.

  • Type: Object
Key Description Details
id The race's identifier. An unique, increasing integer. See details
ap_value How many Adventure Points does the race cost during character creation? See details
base_values The race’s base values. See details
attribute_adjustments Describes how to raise or lower maximum attribute values during character creation. See details
automatic_advantages? A list of automatically applied advantages. This does only work for advantages with no further configuration such as level or special selection. See details
strongly_recommended_advantages? A list of strongly recommended advantages. See details
strongly_recommended_disadvantages? A list of strongly recommended disadvantages. See details
weight Configuration for random weight generation. See details
starting_age Defines the starting ages for the race. It depends on the selected experience level. See details
variants A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race. See details
src See details
translations All translations for the entry, identified by IETF language tag (BCP47). See details

id

The race's identifier. An unique, increasing integer.

  • Type: Integer
  • Minimum: 1

ap_value

How many Adventure Points does the race cost during character creation?

  • Type: Integer
  • Minimum: 0

base_values

The race’s base values.

attribute_adjustments

Describes how to raise or lower maximum attribute values during character creation.

automatic_advantages?

A list of automatically applied advantages. This does only work for advantages with no further configuration such as level or special selection.

strongly_recommended_advantages?

A list of strongly recommended advantages.

strongly_recommended_disadvantages?

A list of strongly recommended disadvantages.

weight

Configuration for random weight generation.

starting_age

Defines the starting ages for the race. It depends on the selected experience level.

variants

A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race.

src

translations

All translations for the entry, identified by IETF language tag (BCP47).

Race/automatic_advantages[]

Race/strongly_recommended_advantages[]

Race/strongly_recommended_disadvantages[]

Race/starting_age[]

BaseValues

The race’s base values.

  • Type: Object
Key Description Details
life_points The race’s life point base value. See details
spirit The race’s Spirit base value. See details
toughness The race’s Toughness base value. See details
movement The race’s tactical movement rate. See details

life_points

The race’s life point base value.

  • Type: Integer

spirit

The race’s Spirit base value.

  • Type: Integer

toughness

The race’s Toughness base value.

  • Type: Integer

movement

The race’s tactical movement rate.

  • Type: Integer
  • Minimum: 1

AttributeAdjustments

Describes how to raise or lower maximum attribute values during character creation.

  • Type: Object
  • Minimum Properties: 1
Key Description Details
fixed? The values by which the maximum of the respective attribute is modified. See details
selectable? An array of attribute maximum modifiers, where the attribute they apply to is selected from a list of options. See details

fixed?

The values by which the maximum of the respective attribute is modified.

selectable?

An array of attribute maximum modifiers, where the attribute they apply to is selected from a list of options.

The array only permits a single entry because no race specified more than one selectable attribute adjustment so far. But the schema allows for multiple entries to be future-proof.

AttributeAdjustments/fixed[]

AttributeAdjustments/selectable[]

FixedAttributeAdjustment

A value by which the maximum of the respective attribute is modified.

  • Type: Object
Key Description Details
id The attribute the modifier applies to. See details
value The value by which the specified attribute's maximum is modified (negative values will lower the maximum). See details

id

The attribute the modifier applies to.

value

The value by which the specified attribute's maximum is modified (negative values will lower the maximum).

  • Type: Integer

SelectableAttributeAdjustment

A value that will be added to the current maximum of the selected attribute that has been chosen from the listed attributes (negative values will lower the maximum).

  • Type: Object
Key Description Details
list A list of attributes the player has to choose from. See details
value The value by which the selected attribute's maximum is modified (negative values will lower the maximum). See details

list

A list of attributes the player has to choose from.

value

The value by which the selected attribute's maximum is modified (negative values will lower the maximum).

  • Type: Integer

SelectableAttributeAdjustment/list[]

RandomWeightGeneration

Configuration for random weight generation.

  • Type: Object
Key Description Details
base The base value used for random weight. The height subtrahend; in case of Height - 110 + 2D6 it is 110. See details
random The dice used for random weight. See details

base

The base value used for random weight. The height subtrahend; in case of Height - 110 + 2D6 it is 110.

  • Type: Integer
  • Minimum: 1

random

The dice used for random weight.

RandomWeightGeneration/random[]

WeightDice

  • Type: Object
Key Description Details
number Number of dice of the same type. Example: 2 in 2D6. See details
sides Number of sides on every die. Example: 6 in 2D6. See details
offset_strategy The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted. See details

number

Number of dice of the same type. Example: 2 in 2D6.

  • Type: Integer
  • Minimum: 1

sides

Number of sides on every die. Example: 6 in 2D6.

offset_strategy

The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted.

WeightDiceOffsetStrategy

The strategy how to offset the randomly generated values against the base value. Either they are all added or subtracted or even results are added and odd results are subtracted.

WeightDiceOffsetStrategy'0

  • Constant: "Add"

WeightDiceOffsetStrategy'1

  • Constant: "Subtract"

WeightDiceOffsetStrategy'2

  • Constant: "AddEvenSubtractOdd"

StartingAgeConfigForExperienceLevel

  • Type: Object
Key Description Details
id The selected experience level's identifier. See details
base The base value for the selected experience level. See details
random The random value for the selected experience level. It is going to be added to the base value. See details

id

The selected experience level's identifier.

base

The base value for the selected experience level.

  • Type: Integer
  • Minimum: 1

random

The random value for the selected experience level. It is going to be added to the base value.

RaceVariants

A list of available race variants where one has to be selected. If no variants are to be selected, a single variant with no name has to be provided which will be used as the missing values for the base race.

RaceVariants[]

Race Variant (RaceVariant)

  • Type: Object
Key Description Details
id An unique, increasing integer. See details
common_cultures The list of common cultures. See details
common_advantages? A list of common advantages. See details
common_disadvantages? A list of common disadvantages. See details
uncommon_advantages? A list of uncommon advantages. See details
uncommon_disadvantages? A list of uncommon disadvantages. See details
hair_color An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color. See details
eye_color An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color. See details
height Configuration for random height generation. See details
translations All translations for the entry, identified by IETF language tag (BCP47). See details

id

An unique, increasing integer.

  • Type: Integer
  • Minimum: 1

common_cultures

The list of common cultures.

common_advantages?

A list of common advantages.

common_disadvantages?

A list of common disadvantages.

uncommon_advantages?

A list of uncommon advantages.

uncommon_disadvantages?

A list of uncommon disadvantages.

hair_color

An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color.

eye_color

An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color.

height

Configuration for random height generation.

translations

All translations for the entry, identified by IETF language tag (BCP47).

RaceVariant/common_cultures[]

RaceVariant/common_advantages[]

RaceVariant/common_disadvantages[]

RaceVariant/uncommon_advantages[]

RaceVariant/uncommon_disadvantages[]

RaceVariant/hair_color[]

RaceVariant/eye_color[]

Height

Configuration for random height generation.

  • Type: Object
Key Description Details
base The base value used for random height. See details
random The dice used for random height. See details

base

The base value used for random height.

  • Type: Integer
  • Minimum: 1

random

The dice used for random height.

Height/random[]

RaceVariantTranslation

  • Type: Object
Key Description Details
name? The race variant's name. If left empty, it defaults to the base race name. This can be used if the race has no (visible) variants so that a single variant has to be provided. See details
common_advantages? The respective common advantages text from the source book. See details
common_disadvantages? The respective common disadvantages text from the source book. See details
uncommon_advantages? The respective uncommon advantages text from the source book. See details
uncommon_disadvantages? The respective uncommon disadvantages text from the source book. See details

name?

The race variant's name. If left empty, it defaults to the base race name. This can be used if the race has no (visible) variants so that a single variant has to be provided.

common_advantages?

The respective common advantages text from the source book.

common_disadvantages?

The respective common disadvantages text from the source book.

uncommon_advantages?

The respective uncommon advantages text from the source book.

uncommon_disadvantages?

The respective uncommon disadvantages text from the source book.

RaceTranslation

  • Type: Object
Key Description Details
name The race's name. See details
attribute_adjustments The respective attribute adjustments text from the source book. See details
automatic_advantages? The respective automatic advantages text from the source book. See details
strongly_recommended_advantages? The respective strongly recommended advantages text from the source book. See details
strongly_recommended_disadvantages? The respective strongly recommended disadvantages text from the source book. See details
errata? See details

name

The race's name.

attribute_adjustments

The respective attribute adjustments text from the source book.

automatic_advantages?

The respective automatic advantages text from the source book.

strongly_recommended_advantages?

The respective strongly recommended advantages text from the source book.

strongly_recommended_disadvantages?

The respective strongly recommended disadvantages text from the source book.

errata?

Reference in New Issue View Git Blame Copy Permalink