TheBrewingProject

Minimal required version: 3.3.0

Items

Brew

Syntax: tbp_brew <brew-id> [quality] [quest-item]
Description: A brew item definition

TheBrewingProject brew item usage is integrated to the Items system and can therefore be used for actions and conditions.

Parameter	Type	Explanation
brew-id [String]	Required	Specifies the type of brew
quality [Quality]	Optional [NONE]	The quality of the brew, if not specified this will not be validated against
quest-item [Boolean]	Flag [false]	Mark this item as a quest item

Example

items:
  beer: 'tbp_brew beer quality:excellent'
  hotChocolate: "tbp_brew hot_choc quest-item"
conditions:
  hasBeer: "item beer"
  hasHotChocolateInHand: "hand hotChocolate"
actions:
  giveHotChocolate: "give hotChocolate"
  takeBeer: "take beer"

Conditions

Modifier

Context: Syntax: tbp_modifier <modifier-id> <operation> <value>
Description: Compare players modifier with specified value

Parameter	Type	Explanation
modifier-id [String]	Required	The id of the modifier
operation [Operation]	Required	The comparison oparator
value [Number]	Required	The value to compare against

Example

conditions:
  drunk50: "tbp_modifier alcohol > 50"

Actions

Event

Context:
Syntax: tbp_event <event-id>
Description: Trigger a drunken event with the specified id

Parameter	Type	Explanation
event-id [String]	Required	The id of the event to run

Example

actions:
  puke: "tbp_event <event-key>"

Objectives

Cook

Heated cauldron brew creation.

Context:
Syntax: tbp_cook <cooking-time> <ingredients> [cauldron-type]
Description: The player needs to have extracted a brew from a cauldron with specified properties

Parameter	Type	Explanation
cooking-time [Number]	Requried	The time in minutes the brew has to be cooked for
ingredients [Ingredients]	Required	The ingredients added into the cauldorn
cauldron [CauldronType]	Optional [NONE]	The type of the cauldron block

Example

objectives:
  beerBase: "tbp_cook 8 wheat/6 cauldron:water"
  failedBase: "tbp_cook 2 wheat/6,apple/3 cauldron:lava"

Mix

Cold cauldron brew creation.

Context:
Syntax: tbp_mix <mixing-time> <ingredients> [cauldron-type]
Description: The player needs to have extracted a brew from a cauldron with specified properties

Parameter	Type	Explanation
mixing-time [Number]	Required	The time in minutes the brew has to be mixed for
ingredients [Ingredients]	Required	The ingredients added into the cauldron
cauldron [CauldronType]	Optional[NONE]	The type of the cauldron contents

Example

objectives:
  cook: "tbp_mix 2 brewery:gin/3,chorus_fruit/6 cauldron:water"

Distill

Context:
Syntax: tbp_distill <distill-runs>
Description: The player needs to have extracted a brew from a distillery with specified runs

Parameter	Type	Explanation
distill-runs [Number]	Required	Tha amount of runs of the extracted brew

Example

objectives:
  cook: "tbp_distill 6"

Age

Context:
Syntax: tbp_age <barrel-type> <aging-years>
Description: The player needs to have extracted a brew from a barrel with specified properties

Note that an aging year might change if TheBrewingProject reloads.

Parameter	Type	Explanation
barrel-type [BarrelType]	Required	The type of the barrel
aging-years [Number]	Required	The time the brew needs to have aged (needs to be larger than 0.5)

Example

objectives:
  cook: "tbp_age any 1"

Transfer

Context:
Syntax: tbp_transfer <transfer-type> <structure-type> <brew-id> <operator> <brew-quality>
Description: The player needs to have transferred a brew with given conditions

Parameter	Type	Description
transfer-type [TransferType]	Required	If the player extracted or inserted the brew
structure-type [StructureType]	Required	The type of structure the transfer is from or to
brew-id [String]	Required	The recipe key the brew matches
operator [Operation]	Required	A comparison between brew quality
brew-quality [Quality]	Required	The brew quality to compare against

Example

objectives:
  extract: "tbp_transfer extract barrel beer > good" # Only excellent brews will match
  insert: "tbp_transfer insert barrel whiskey > bad" # Good and excellent brews will match
  extract2: "tbp_transfer extract distillery whiskey != good" # Poor and excellent brews will match

Consume

Context:
Syntax: tbp_consume <brew-id> <operator> <brew-quality>
Description: The player needs to have consumed a brew with given properties

Parameter	Type	Description
brew-id [String]	Required	The recipe key the brew matches
operator [Operation]	Required	A comparison between brew quality
brew-quality [Quality]	Required	The brew quality to compare to

Example

objectives:
  consume: "tbp_consume beer > good" # Only matches against excellent brews

Event

Context:
Syntax: tbp_event <event-id>
Description: The player needs to experience a drunken event with specified key

Parameter	Type	Description
event-id [String]	Required	The id of the event a player experienced

Example

objectives:
  consume: "tbp_event puke"
  gsitSit: "tbp_event gsit:sit" # If there's integrations available, you can specify those

StructureDestroy

Context:
Syntax: tbp_structure_destroy <structure-type>
Description: The player needs to destroy a brewing structure with specified type

Parameter	Type	Explanation
structure-type [StructureType]	Required	The structure type the player needs to destroy

Example

objectives:
  structureDestroyed: tbp_structure_destroy barrel

StructureCreate

Context:
Syntax: tbp_structure_create <structure-type>
Description: The player needs to create a brewing structure with specified type

Parameter	Type	Explanation
structure-type [StructureType]	Required	The structure type the player needs to destroy

Example

objectives:
  structureCreated: tbp_structure_create distillery