Code Monkey home page Code Monkey logo

batlogic-forks / cats-blender-plugin Goto Github PK

View Code? Open in Web Editor NEW

This project forked from absolute-quantum/cats-blender-plugin

0.0 1.0 0.0 53.26 MB

:smiley_cat: A tool designed to shorten steps needed to import and optimize models into VRChat. Compatible models are: MMD, XNALara, Mixamo, DAZ/Poser, Blender Rigify, Sims 2, Motion Builder, 3DS Max and potentially more

Home Page: https://catsblenderplugin.com

License: MIT License

Python 100.00%

cats-blender-plugin's Introduction

Cats Blender Plugin (0.16.1)

A tool designed to shorten steps needed to import and optimize models into VRChat. Compatible models are: MMD, XNALara, Mixamo, Source Engine, Unreal Engine, DAZ/Poser, Blender Rigify, Sims 2, Motion Builder, 3DS Max and potentially more

With Cats it takes only a few minutes to upload your model into VRChat. All the hours long processes of fixing your models are compressed into a few functions!

So if you enjoy how this plugin saves you countless hours of work consider supporting us through Patreon. There are a lot of perks like having your name inside the plugin!

Download here: Cats Blender Plugin

Features

  • Optimizing model with one click!
  • Creating lip syncing
  • Creating eye tracking
  • Automatic decimation
  • Creating custom models easily
  • Creating texture atlas
  • Creating root bones for Dynamic Bones
  • Optimizing materials
  • Translating shape keys, bones, materials and meshes
  • Merging bone groups to reduce overall bone count
  • Protecting your avatars from game cache ripping
  • Auto updater

More to come!

Discord

Join our Discord to report errors, suggestions and make comments!

Discord: https://discord.gg/f8yZGnv

Requirements

  • Blender 2.79 or 2.80 or 2.81 (run as administrator is recommended)
    • mmd_tools is no longer required! Cats comes pre-installed with it!
  • If you have custom Python installed which Blender might use, you need to have Numpy installed

Installation

  • Check your 3d view and there should be a new menu item called CATS ....w00t
    • Since Blender 2.80 the CATS tab is on the right in the menu that opens when pressing 'N'

  • If you need help figuring out how to use the tool:

VRChat - Cat's Blender Plugin Overview

Skip the step where he installs "mmd_tools" in the video below, it's not needed anymore!

VRChat - Importing an MMD to VRChat Megatutorial!

Code contributors:

  • Hotox
  • Shotariya
  • Neitri
  • Kiraver

Model

This tries to completely fix your model with one click.

Import/Export Model
  • Imports a model of the selected type with the optimal settings
  • Exports a model as an .fbx with the optimal settings
Fix Model
  • Fixes your model automatically by:
    • Reparenting bones
    • Removing unnecessary bones
    • Renaming and translating objects and bones
    • Mixing weight paints
    • Rotating the hips
    • Joining meshes
    • Removing rigidbodies, joints and bone groups
    • Removing bone constraints
    • Deleting unused vertex groups
    • Using the correct shading
    • Making it compatible with Full Body Tracking
    • Combining similar materials
Start Pose Mode
  • Lets you test how bones will move.
Pose to Shape Key
  • Saves your current pose as a new shape key.
Apply as Rest Pose
  • Applies the current pose position as the new rest position. This saves the shape keys and repairs ones that were broken due to scaling

Model Options

Translation
  • Translate certain entities from any japanese to english. This uses an internal dictionary and Google Translate.
Separate by material / loose parts / shapes
  • Separates a mesh by materials or loose parts or by whether or not the mesh is effected by a shape key
Join meshes
  • Joins all/selected meshes together
Merge Weights
  • Deletes the selected bones and adds their weight to their respective parents
Delete Zero Weight Bones
  • Cleans up the bones hierarchy, deleting all bones that don't directly affect any vertices
Delete Constraints
  • Removes constrains between bones causing specific bone movement as these are not used by VRChat
Recalculate Normals
  • Makes normals point inside of the selected mesh
  • Don't use this on good looking meshes as this can screw them up
Flip Normals
  • Flips the direction of the faces' normals of the selected mesh.
Apply Transformations
  • Applies the position, rotation and scale to the armature and its meshes.
Remove Doubles
  • Merges duplicated faces and vertices of the selected meshes.

Custom Model Creation

This makes creating custom avatars a breeze!

Merge Armatures
  • Merges the selected armature into the selected base armature.
  • How to use:
    • Use "Fix Model" on both armatures
      • Select the armature you want to fix in the list above the Fix Model button
      • Ignore the "Bones are missing" warning if one of the armatures is incomplete (e.g hair only)
      • If you don't want to use "Fix Model" make sure that the armature follows the CATS bone structure (https://i.imgur.com/F5KEt0M.png)
      • DO NOT delete any main bones by yourself! CATS will merge them and delete all unused bones afterwards
    • Now you have two options:
      • Only move the mesh:
        • Uncheck the checkbox "Apply Transforms"
        • Move the mesh (and only the mesh!) of the merge armature to the desired position
          • You can use Move, Scale and Rotate
          • CATS will position the bones according to the mesh automatically
      • OR move the armature (and with it the mesh):
        • Check the checkbox "Apply Transforms"
        • Move the armature to the desired position
          • You can use Move, Scale and Rotate
          • Make sure that both meshes and armatures are at their correct positions as they will stay exactly like this
      • If you want to merge multiple objects from the same model it is often better to duplicate the armature for each of them and merge them individually
    • Select the base armature and the armature you want to merge into the base armature in the panel
    • If CATS can't detect the bone structure automatically: select a bone you want to attach the new armature to
      • E.g.: For a hair armature select "Head" as the bone
    • Press the "Merge Armatures" button -> Done!
Attach Mesh to Armature
  • Attaches the selected mesh to the selected armature.
  • How to use:
    • Move the mesh to the desired position
      • You can use Move, Scale and Rotate
      • INFO: The mesh will only be assigned to the selected bone
      • E.g.: A jacket won't work, because it requires multiple bones.
      • E.g.: A ring on a finger works perfectly, because the ring only needs one bone to move with (the finger bone)
    • Select the base armature and the mesh you want to attach to the base armature in the panel
    • Select the bone you want to attach the mesh to in the panel
    • Press the "Attach Mesh" button -> Done!
Support us:
  • We worked hard on this feature. If you like it consider supporting us, it helps a lot!

Decimation

Decimate your model automatically.

Save Decimation
  • This will only decimate meshes with no shape keys.
Half Decimation
  • This will only decimate meshes with less than 4 shape keys as those are often not used.
Full Decimation
  • This will decimate your whole model deleting all shape keys in the process.
Custom Decimation
  • This will let you choose which meshes and shape keys should not be decimated.

Eye Tracking

Eye tracking is used to artificially track someone when they come close to you. It's a good idea to check the eye movement in the testing tab after this operation to check the validity of the automatic eye tracking creation.

Disable Eye Blinking
  • Disables eye blinking. Useful if you only want eye movement.
Disable Eye Movement
  • Disables eye movement. Useful if you only want blinking. IMPORTANT: Do your decimation first if you check this!
Eye Movement Speed
  • Configure eye movement speed

Visemes (Lip Sync)

Mouth visemes are used to show more realistic mouth movement in-game when talking over the microphone. The script generates 15 shape keys from the 3 shape keys you specified. It uses the mouth visemes A, OH and CH to generate this output.

Bone parenting

Useful for Dynamic Bones where it is ideal to have one root bone full of child bones. This works by checking all bones and trying to figure out if they can be grouped together, which will appear in a list for you to choose from. After satisfied with the selection of this group you can then press 'Parent bones' and the child bones will be parented to a new bone named RootBone_xyz

To parent
  • List of bones that look like they could be parented together to a root bone. Select a group of bones from the list and press "Parent bones"
Refresh list
  • Clears the group bones list cache and rebuild it, useful if bones have changed or your model
Parent bones
  • Starts the parent process

Texture atlas

Texture atlas is the process of combining multiple textures into one to drastically reduce draw calls and therefore make your model much more performant

Create Atlas
  • Combines all selected materials into one texture. If no material list is generated it will combine all materials.
Generate Material List
  • Lists all materials of the current model and lets you select which ones you want to combine.

Useful Tips:

  • Split transparent and non-transparent textures into separate atlases to avoid transparency issues
  • Make sure that the created textures are not too big, because Unity will downscale them to 2048x2048. Split them across multiple atlases or reduce the individual texture sizes. This can be easily done in the MatCombiner tab.
  • You can tell Unity to use up to 8k textures. Do so by selecting the texture and then choose a different Max Size and/or Compression in the inspector: https://i.imgur.com/o01T4Gb.png

Bone merging

Lets you reduce overall bone count in a group set of bones. This works by checking all bones and trying to figure out if they can be grouped together, which will appear in a list for you to choose from. After satisfied with the selection of this group you can then set a percentage value how much bones you would like to merge together in itself and press 'Merge bones'

Refresh list
  • Clears the group bones list cache and rebuild it, useful if bones have changed or your model
Merge bones
  • Starts the merge process

Shape Key

Apply Shape Key as Basis

  • Applies the selected shape key as the new Basis and creates a reverted shape key from the selected one.

Settings and Updates

This plugin has an auto updater. It checks for a new version automatically once every day.

Changelog

0.16.1

  • Fixed export warning bug

0.16.0

  • Cats is now fully compatible with Blender 2.81!
  • Importer:
    • Added support for ZIP files
      • It will only extract the zip if importable models are found
      • If multiple models are found in the zip, you can select the one you want in a popup window
      • Japanese zip files will be extracted with the correct encoding
    • Models can now be imported with Cats via the Windows command shell
  • Fix Model:
    • Hips bone will now be larger than before, to comply with the VRChat recommendations
    • FFXIV models are now compatible
    • Added "Fix Materials" option in Blender 2.80 and higher
      • This will apply some VRChat related fixes to materials
      • This has always been done in Fix Model but now you can turn it off
  • Model Options:
    • Remove Doubles no longer effects meshes with no shapekeys
  • Custom Model Creation:
    • Added "Join Meshes" option
    • Merge Armatures and Attach Mesh no longer require a mesh on the armature
    • Fixed bones from the merge armature sometimes getting unintentionally deleted
  • Optimization:
    • Added manual download button if Material Combiner is outdated
  • Copy Protection:
    • Removed Copy Protection panel
      • It is no longer a good method for protecting against cache ripping and it can cause performance and lighting issues
  • General:
    • Armatures will no longer be forced into rest position after any action
    • Fixed armatures sometimes not getting detected
    • Small bug fixes
    • Updated mmd_tools

0.15.0

  • Importer:
    • FBX no longer imports animations and poses by default
  • Fix Model:
    • Now always applies transforms of the model
    • Added "Keep Upper Chest" option
      • Warning: Currently having an Upper Chest breaks Eye Tracking, so don't use this if you want Eye Tracking
    • Removed "Fix Full Body Tracking" option
      • It is no longer needed for VRChat
      • The button to add/remove the fix is still available in Model Options
    • Improved Hips placement as recommended by VRChat
    • Legs are now getting bend forward very slightly if they are completely straight
    • Fixed a bug which could sometimes delete bones unintentionally
  • Model:
    • Fixed pose mode error in 2.80
  • Model Options:
    • Added new "Delete Zero Weight Vertex Groups" button
    • Improved layout of the "Full Body Tracking Fix" buttons
    • Fixed visual "Merge Weights" bug in Blender 2.80
  • Optimization:
    • Improved Material Combiner detection algorithm
  • General:
    • Updated mmd_tools

Read the full changelog here.

Roadmap

  • MOAR updates on the armature code
  • Texture translation should have an option to rename the filename also
  • Automatic lower lid creation for eye tracking
  • Manual bone selection button for root bones
  • Full body tracking proportion adjustments

Feedback

Do you love this plugin or have you found a bug? Post a response in this thread or send your feedback to the official discord server of the plugin for real-time communication: https://discord.gg/f8yZGnv and look for people with the developer role ;)

Support us

If you enjoy how this plugin saves you countless hours of work consider supporting us through Patreon:

cats-blender-plugin's People

Contributors

absolute-quantum avatar blueamulet avatar darkblader24 avatar larskue avatar netri avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.