Update Configuration.md authored by Ticxo's avatar Ticxo
......@@ -2,6 +2,8 @@
* [Default Animations](#default-animations)
* [Print Script Warnings](#print-script-warnings)
* [Use State Machine](#use-state-machine)
* [Engine Threads](#engine-threads)
* [Max Engine Threads](#max-engine-threads)
* [Model Generator](#model-generator)
* [Register Post Server](#register-post-server)
* [Assets Post Server](#assets-post-server)
......@@ -12,11 +14,14 @@
* [Create Zip](#create-zip)
* [Create Atlas](#create-atlas)
* [Create Shader](#create-shader)
* [Create MC-META](#create-mc-meta)
* [Item Model](#item-model)
* [Network Optimization](#network-optimization)
* [Bundle Everything](#bundle-everything)
* [Bundle Size](#bundle-size)
* [Cull Interval](#cull-interval)
* [Culling Threads](#culling-threads)
* [Max Culling Threads](#max-culling-threads)
* [Vertical Render Distance](#vertical-render-distance)
* [Skip Models Behind Viewer](#skip-models-behind-viewer)
* [Skip Blocked Models](#skip-blocked-models)
......@@ -41,6 +46,15 @@ Whether warning messages should be printed when an error occurred on a script ke
Whether to use the new state machine animation system by default.
Although defaulted to false, it is recommended to migrate all models to using this system.
### Engine Threads
The initial amount of threads used to processing model animations.
### Max Engine Threads
The maximum amount of threads Model Engine can create to process model animations. The amount must be more than the
value set at [Engine Threads](#engine-threads).
---
## Model Generator
......@@ -88,6 +102,12 @@ Should Model Engine create an atlas file automatically.
Should Model Engine create the shaders used for [player limb bone behavior](Modeling/Bone-Behaviors#player-limbs-tags).
### Create MC-META
Should Model Engine generate MC-META files for animated textures.
This does **NOT** stop generation if the model contains metadata saved through
the [MC-META blockbench plugin](Modeling/Optional-Tools#mc-meta), which we highly recommend using.
### Item Model
The item model used to create overrides for all generated models.
......@@ -130,6 +150,15 @@ Minecraft by default only allow up to 4096 packets in a single bundle.
The culling interval of an Active Model. Smaller value means more frequent detection but more calculations.
### Culling Threads
The initial amount of threads used to processing model culling.
### Max Culling Threads
The maximum amount of threads Model Engine can create to process model culling. The amount must be more than the value
set at [Culling Threads](#culling-threads).
### Vertical Render Distance
Culls the model when the vertical distance between the model's render hitbox and the eye position of the view exceeds a
......@@ -155,9 +184,10 @@ Culls the model when angle between the viewer and the model exceeds the configur
Culls the model when the model is being blocked by view-occluding blocks.
| Key | Description | Default |
|---------------------|-----------------------------------------------------------------------------------|---------|
|-----------------------|-----------------------------------------------------------------------------------|---------|
| Force-Render-Radius | Minimum distance between the viewer and the model for it the be culled in blocks. | 5 |
| Force-Render-Size | Minimum render hitbox width or height to give up on culling. | 32 |
| Cull-Type | [Culling behavior][] | CULLED |
| Use-Paper-Clip-Method | Whether the culling method should use the paper variant of the raytrace method. | false |
[Culling behavior]: Technical/Terminology#culltype
\ No newline at end of file