========
pack.yml
========

The config pack manifest.

Defines things that are applicable pack-wide.


.. _config-pack.yml-template-base-base-parameter-biomes:

:bdg-ref-primary:`biomes <config-pack.yml-template-base-base-parameter-biomes>` :doc:`/config/documentation/objects/BiomeProvider` - Determines where biomes should generate in the world.

.. _config-pack.yml-template-base-base-parameter-generator:

:bdg-ref-primary:`generator <config-pack.yml-template-base-base-parameter-generator>` :doc:`/config/documentation/objects/ChunkGenerator` - Determines which chunk generator to use.

Chunk generators set the initial blocks in a chunk before any generation stages are applied.


.. _config-pack.yml-template-base-base-parameter-id:

:bdg-ref-primary:`id <config-pack.yml-template-base-base-parameter-id>` :doc:`/config/documentation/objects/String` - The id used to identify the config pack.

This will be used to specify the config pack as a world generator by the platform.


.. _config-pack.yml-template-base-base-parameter-stages:

:bdg-ref-primary:`stages <config-pack.yml-template-base-base-parameter-stages>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/GenerationStage`\> - A list of generation stages.

Generation stages are applied sequentially after initial chunk generation done by the defined :doc:`/config/documentation/objects/ChunkGenerator`.


.. _config-pack.yml-template-base-base-parameter-version:

:bdg-ref-primary:`version <config-pack.yml-template-base-base-parameter-version>` Version - The version of the config pack.

.. _config-pack.yml-template-base-base-parameter-author:

:bdg-ref-success:`author <config-pack.yml-template-base-base-parameter-author>` :doc:`/config/documentation/objects/String` - Who developed the config pack.

Default: ``Anon Y. Mous``

---------

:superscript:`*Parameters require the 'chunk-generator-noise-3d' addon to use`

The following parameters are only applicable if :bdg-primary:`generator` is set to ``NOISE_3D``

.. _config-pack.yml-template-chunk-generator-noise-3d-base-parameter-blend.terrain.elevation:

:bdg-ref-success:`blend.terrain.elevation <config-pack.yml-template-chunk-generator-noise-3d-base-parameter-blend.terrain.elevation>` :doc:`/config/documentation/objects/Integer` 

Default: ``4``

.. _config-pack.yml-template-chunk-generator-noise-3d-base-parameter-carving.resolution.horizontal:

:bdg-ref-success:`carving.resolution.horizontal <config-pack.yml-template-chunk-generator-noise-3d-base-parameter-carving.resolution.horizontal>` :doc:`/config/documentation/objects/Integer` 

Default: ``4``

.. _config-pack.yml-template-chunk-generator-noise-3d-base-parameter-carving.resolution.vertical:

:bdg-ref-success:`carving.resolution.vertical <config-pack.yml-template-chunk-generator-noise-3d-base-parameter-carving.resolution.vertical>` :doc:`/config/documentation/objects/Integer` 

Default: ``2``

.. _config-pack.yml-template-chunk-generator-noise-3d-base-parameter-slant.calculation-method:

:bdg-ref-success:`slant.calculation-method <config-pack.yml-template-chunk-generator-noise-3d-base-parameter-slant.calculation-method>` SlantCalculationMethod 

Default: ``Derivative``

---------

:superscript:`*Parameters require the 'config-noise-function' addon to use`

.. _config-pack.yml-template-config-noise-function-base-parameter-functions:

:bdg-ref-success:`functions <config-pack.yml-template-config-noise-function-base-parameter-functions>` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - A set of math functions globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files.

Default: ``{}``

.. note::
  
  Functions defined under this parameter cannot reference each other, and are only
  able to be used in other config files.


.. _config-pack.yml-template-config-noise-function-base-parameter-samplers:

:bdg-ref-success:`samplers <config-pack.yml-template-config-noise-function-base-parameter-samplers>` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - A set of samplers globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files.

Default: ``{}``

.. note::
  
  Samplers defined under this parameter cannot reference each other, and are only
  able to be used in other config files.


---------

:superscript:`*Parameters require the 'library-image' addon to use`

.. _config-pack.yml-template-library-image-base-parameter-images.cache.load-on-use:

:bdg-ref-success:`images.cache.load-on-use <config-pack.yml-template-library-image-base-parameter-images.cache.load-on-use>` :doc:`/config/documentation/objects/Boolean` 

Default: ``False``

If set to true, images will load into memory upon use rather than on pack load.


.. _config-pack.yml-template-library-image-base-parameter-images.cache.timeout:

:bdg-ref-success:`images.cache.timeout <config-pack.yml-template-library-image-base-parameter-images.cache.timeout>` :doc:`/config/documentation/objects/Integer` - How many seconds to keep images loaded in the image cache for.

Default: ``0``

If set to a number greater than 0, images will be removed from memory if not used after the timeout, otherwise images
will stay loaded in memory. Setting the timeout to greater than 0 will trade decreased memory consumption when not
performing any image reads for a period of time for extra processing time required to perform cache lookups.