MonsterDB

Plugin allows users to manipulate variables of monsters in the game and clone them

Commands

Only admins can use the commands

monsterdb write [prefabName]                    - Writes monster data to disk
monsterdb update [prefabName]                   - Forice updates monster using registered data
monsterdb clone [prefabName] [cloneName]        - Clones prefab and registers data
monsterdb reset [prefabName]                    - Resets prefab to orignal data
monsterdb reload                                - Updates all registered data
monsterdb write_item [prefabName]               - If prefab is an item (monster attack data), writes data to disk to use as reference
monsterdb clone_item [prefabName] [cloneName]   - clones prefab and saves to items folder, copy it to your creatures item folders
monsterdb write_spawn [prefabName]              - Writes spawn data - location dependant, go to area where creature spawns
monsterdb import                                - imports all creature data files in the Import directory
monsterdb export [prefabName]                   - exports to a single file creature data to share
monsterdb write_all                             - exports all creatures (will take a while)

How To

In-game, use the commands to write data to disk to start manipulating monsters

Plugin will watch the files and update the monsters upon any changes

You will find list of data organized into folders

Effects        // Specific files are set in this folder for you to manipulate
Items          // Humanoid creatures only - folders are organized in this
Visual         // Manipulate the materials and scale

Effects Folder

Files generated are based on the data in the game, if you make creature tameable or talker, you will need to add the missing YML files

Example:
Tameable component looks for:
- LoveEffects.yml
- PetEffects.yml
- SoothEffects.yml
- UnsummonEffecst.yml

These files contains list of effects. You can add or remove items in this list.

How to make creature tameable

You will to add two files to make creature tameable:

- MonsterAI.yml
- Tameable.yml

Copy the data from the AnimalAI.yml file into the MonsterAI.yml, without removing the extra lines in the MonsterAI.yml file. (line 39+):

MonsterAI is AnimalAI plus extra data:

AlertRange: 6
FleeIfHurtWhenTargetCannotBeReached: true
FleeUnreachableSinceAttack: 30
FleeUnreachableSinceHurt: 20
FleeIfNotAlerted: true
FleeIfLowHealth: 0
FleeTimeSinceHurt: 0
FleeInLava: true
CirculateWhileCharging: true
CirculateWhileChargingFlying: false
EnableHuntPlayer: false
AttackPlayerObjects: true
PrivateAreaTriggerThreshold: 4
InterceptTimeMax: 1
InterceptTimeMin: 0
MaxChaseDistance: 0
MinAttackInterval: 0
CircleTargetInterval: 0
CircleTargetDuration: 5
CircleTargetDistance: 10
Sleeping: false
WakeupRange: 5
NoiseWakeup: false
MaxNoiseWakeupRange: 50
WakeupDelayMin: 0
WakeupDelayMax: 0
AvoidLand: false
ConsumeItems:
- Carrot
- Turnip
- Onion
- Mushroom
- Raspberry
- Blueberries
ConsumeRange: 1
ConsumeSearchRange: 10
ConsumeSearchInterval: 10

How to make creature talk

Add NPCTalk.yml into the creature folder (only works with MonsterAI creatures - monsters that attack)

If want NPC Talk effects, you will need to add these files in the Effects folder:

- RandomTalkFX.yml
- RandomGreetFX.yml
- RandomGoodbyeFX.yml

Textures

Place png files in the CustomTextures directory

Plugin will load them during boot-up and you can use the file name in the Visual/Materials files

If connecting to a server, the client will check with the server for missing textures and cache them to CustomTextures folder.

Materials

ShaderType: Standard        // Shader Type
Name: Material Name         // Name of material - Used as a key to a know which material to change // Do not change
_Color:                     // Manipulate the color of the material
  r: 0.8529412              // red
  g: 0.8529412              // green
  b: 0.8529412              // blue
  a: 1                      // alpha (Opacity)
_MainTex: ''                // Change the texture using the name of texture, will search in custom textures and in-game textures
_EmissionColor:             // Manipulate the emission of the material (glow)
  r: 0                      // red
  g: 0                      // green
  b: 0                      // blue
  a: 1                      // alpha

If modifying human based creatures, use material colors to define skin and hair color.

Humans

If modifying / creating human creatures, a Human.yml file will generate in the Visual folder.

ModelIndex: (value between 0 - 1) 1 is female
HairIndex: (value between 0 - 20)
beardIndex: (value between 0 - 20)

Particles / Lights

In the folder Visual, you will find a file called Particles.yml if the creature has particle system or light components. You will find booleans (true/false) to toggle to control the creatures visual effects.

How to change attacks

Best practice is to save item data using commands, and use them as reference when manipulating ItemData.yml

Name: Dverger_melee               // ID - You can change this to use a different prefab, although items are quite specific
AnimationState: OneHanded         // State the creature holds the item
SpawnOnHit: ''                    // PrefabName
SpawnOnHitTerrain: ''             // PrefabName
AttackStatusEffect: ''            // StatusEffectName - plugin will search the ObjectDB StatusEffects library for a match
AttackStatusEffectChance: 1       // Value 0 - 1
AttackType: Horizontal            // Type
AttackAnimation: attack_poke      // This field is important and unique to the creature - it is the key to the attack animation
AttackOriginJoint: ''             // Use Visual.txt to know the names of available joints
SpawnOnTrigger: ''                // PrefabName
Projectile: ''                    // PrefabName

How to make creatures spawn

You will find a directory named SpawnData

In this folder, the plugin generates an Example.yml file.

Copy and Paste this file, rename it to something that is not Example.yml

m_name: ''                      // Name of the SpawnData - Does not do anything
m_enabled: false                // Easily enable / disable spawn file
m_devDisabled: false            // Not sure what this does
m_prefab:                       // PrefabName added here
m_biome:                        // Biome added here
m_biomeArea: Everything         // Edge, Median, Everything
m_requiredGlobalKey: ''         // Add key as conditionals
m_requiredEnvironments: []      // List of environment names
m_foldout: false                // Not sure what this does

The command 'write_spawn' attempts to find spawn data matching the creature name, and saves it into a reference folder. These 'reference' files will not modify existing spawn data if added to main folder. Rather, it will add.

These are to be used as references to develop your own spawn files.

Import / Export

monsterdb import                - imports all creature data files in the Import directory
monsterdb export [prefabName]   - exports to a single file creature data to share

You can use this file structure to easily share MonsterDB files with your friends or even use this file structure to create/edit creatures.

Grow Up

GrowTime: 100                 // Set time in seconds
InheritTame: true             // If parent is tamed, inherits
GrownPrefab: Lox
AltGrownPrefabs:
- GrownPrefab: Boar           // If this list has entries, then it will ignore entry above
  Weight: 1                   // and randomly choose based on this list
- GrownPrefab: Neck           // You can create multiple versions of parents this way
  Weight: 1                   // and have children randomly become one of them

Level Effects

Only some creatures have level effects. MonsterDB modifies component to stretch scale a bit farther than normally.

- Scale: 1.1                  // Level 2 ( 1 star )
  Hue: 0                      // -0.5 - 0.5
  Saturation: -0.15           // -1 - 1
  Value: -0.01                // -1 - 1 (Brightness ?)
  SetEmissiveColor: false     // Deer emissive would be its entire body
  EmissiveColor:
    r: 1
    g: 1                      // You can find Object Names in Visual.txt
    b: 1                      // This example is from a Deer
    a: 1                      // The game does not use Level 0 Antlers (Antlers 01)
  EnableObject: Antlers 01    // This example replaces Antler 04 for 01
- Scale: 1.2                  // Level 3 ( 2 stars )
  Hue: 0
  Saturation: -0.4
  Value: -0.04
  SetEmissiveColor: false
  EmissiveColor:
    r: 1
    g: 1
    b: 1
    a: 1
  EnableObject: Antlers 05

Server Sync

Plugin loading steps:

#1 - Plugin boots up and reads local files, saves it internally
#2 - Game loads scene - Plugin creates clones and modifies creatures
#3 - If client connects to a server, server files are transfered to client (not textures)
#4 - If client connects to a server, deletes clones, and resets creature modifications
#5 - clones and modifies based on server data

File Watch

- The plugin will watch MonsterDB folder for any changes. If it detects a change, it will update clones / creatures.
- If client is connected to a server, it will ignore the files.
- If server, it will update the clones / creatures, and send data to clients
- If client detects new server data, it will update clones / creatures

Special considerations

Only Tameable.yml, NPCTalk.yml can be added into creature folders and actually add the components.

Changelog

0.1.1 - Improved write_all command
0.1.0 - Added write_all command
0.0.9 - Added feature to change shaders and toggle creature particles/lights
0.0.8 - Fixed AttackStatusEffect field and added some configs
0.0.7 - Improved commands and fixed human monsters
0.0.6 - Fixed issue when trying to clone a null object
0.0.5 - Client will download textures from server
0.0.4 - Supports grow up and level effects
0.0.3 - Registering cloned items to ObjectDB fix
0.0.2 - Forgot to create MonsterDB folder before writing tutorial
0.0.1 - Beta Release

Contact information

For Questions or Comments, find Rusty in the Odin Plus Team Discord

Or come find me at the Modding Corner

If you enjoy this mod and want to support me: PayPal