Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
Model Engine 4 Model Engine 4
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 111
    • Issues 111
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • MythicCraft
  • Model Engine 4Model Engine 4
  • Wiki
  • Configuration

Configuration · Changes

Page history
Configuration authored Sep 28, 2023 by Ticxo's avatar Ticxo
Show whitespace changes
Inline Side-by-side
Showing with 96 additions and 4 deletions
+96 -4
  • Configuration.md Configuration.md +96 -4
  • No files found.
Configuration.md
View page @ c99dbf09
* Model Engine * [Model Engine](#model-engine)
* [Default Animations](#default-animations) * [Default Animations](#default-animations)
* [Print Script Warnings](#print-script-warnings) * [Print Script Warnings](#print-script-warnings)
* [Use State Machine](#use-state-machine) * [Use State Machine](#use-state-machine)
* Model Generator * [Model Generator](#model-generator)
* [Register Post Server](#register-post-server) * [Register Post Server](#register-post-server)
* [Assets Post Server](#assets-post-server) * [Assets Post Server](#assets-post-server)
* [Compile Post Server](#compile-post-server) * [Compile Post Server](#compile-post-server)
...@@ -12,40 +12,132 @@ ...@@ -12,40 +12,132 @@
* [Create Zip](#create-zip) * [Create Zip](#create-zip)
* [Create Atlas](#create-atlas) * [Create Atlas](#create-atlas)
* [Item Model](#item-model) * [Item Model](#item-model)
* Network Optimization * [Network Optimization](#network-optimization)
* [Cull Interval](#cull-interval) * [Cull Interval](#cull-interval)
* [Vertical Render Distance](#vertical-render-distance) * [Vertical Render Distance](#vertical-render-distance)
* [Skip Models Behind Viewer](#skip-models-behind-viewer) * [Skip Models Behind Viewer](#skip-models-behind-viewer)
* [Skip Blocked Models](#skip-blocked-models) * [Skip Blocked Models](#skip-blocked-models)
---
## Model Engine
This section is responsible for the in-game behaviors while Model Engine is running.
### Default Animations ### Default Animations
Configure the animation names for all default animations.
Some default animations are planned but not fully implemented yet. Don't tell anyone :p
### Print Script Warnings ### Print Script Warnings
Whether warning messages should be printed when an error occurred on a script keyframe.
### Use State Machine ### Use State Machine
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.
---
## Model Generator
This section configures the assets generation settings ran on server start up or model reimport.
### Register Post Server ### Register Post Server
Should the models register after server start up.
If set the false, the server will hang until all models are registered.
Otherwise, the server will be joinable before all models are imported, and all subsequent process will also be run after
server start up.
### Assets Post Server ### Assets Post Server
Should the resource pack be generated after server start up.
If set the false, the server will hang until all assets are generated.
### Compile Post Server ### Compile Post Server
Should the resource pack be zipped after server start up.
If set the false, the server will hang until all assets are generated.
### Enable Error ### Enable Error
Should model error messages be printed.
### Debug Level ### Debug Level
Set the debug level of the Model Engine logger. May sometimes reveal useful information.
### Namespace ### Namespace
Set the namespace of the generated resource pack.
### Create Zip ### Create Zip
Should Model Engine zip the resource pack automatically.
### Create Atlas ### Create Atlas
Should Model Engine create an atlas file automatically.
### Item Model ### Item Model
The item model used to create overrides for all generated models.
Here is a list of usable items. All items shown here are colorable:
| Item |
|---------------------|
| FILLED_MAP |
| LEATHER_BOOTS |
| LEATHER_CHESTPLATE |
| LEATHER_HORSE_ARMOR |
| LEATHER_LEGGINGS |
| LINGERING_POTION |
| POTION |
| SPLASH_POTION |
| TIPPED_ARROW |
---
## Network Optimization
This section allows adjustment to the network optimizations Model Engine provides.
**It is highly recommended to have all optimizations enabled, as they greatly reduce network load, and all optimizations
are configurable on a per-Active Model basis.**
### Cull Interval ### Cull Interval
The culling interval of an Active Model. Smaller value means more frequent detection but more calculations.
### Vertical Render Distance ### 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
certain threshold.
| Key | Description | Default |
|--------------------------|------------------------------------|---------|
| Vertical-Render-Distance | Vertical render distance in blocks | 32 |
| Cull-Type | [Culling behavior][] | CULLED |
### Skip Models Behind Viewer ### Skip Models Behind Viewer
Culls the model when angle between the viewer and the model exceeds the configured threshold.
| Key | Description | Default |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| View-Angle | The view angle of the viewer in degrees, where the model **does not get culled.**<br/>Setting to 360 effectively disables this culling method. | 180 |
| Force-Render-Radius | Minimum distance between the viewer and the model for it the be culled in blocks. | 5 |
| Cull-Type | [Culling behavior][] | MOVEMENT_ONLY |
### Skip Blocked Models ### Skip Blocked Models
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 |
[Culling behavior]: Technical/Terminology#CullType
\ No newline at end of file
Clone repository
Home
FAQ / Common Issues
Commands & Permissions
Configuration
Modeling
  • Creating a Model
    • Hitbox & Eye Height
    • Shadow
  • Bone Behaviors
  • Animating a Model
  • Importing a Model
  • Scriptable Keyframes
MythicMobs
  • Mechanics: Model
  • Mechanics: VFX
  • Conditions
  • Targeters
API
  • Basic
    • Apply / Remove Model
    • Play / Stop Animation
    • Configure Bone Behaviors
    • Per-Player Model
    • Events
  • Advanced
    • Custom Base Entity
    • Custom Mount Controller
    • Custom Importer
    • Custom Bone Behaviors
    • Custom Script Reader
    • Custom Timeline
    • Custom Animation Handler
    • Custom Render Type
Technical
  • Terminology
  • Animation Systems
  • Mount Controllers