Files
Avatar-Toolkit/README.md
T
2025-08-09 15:35:15 +01:00

76 lines
3.3 KiB
Markdown

# Avatar Toolkit
## Avatar Toolkit is in Alpha, There will be issues, please ensure you report them!. If using a Alpha plugin isn't your fancy you can find Cats Blender Plugin [HERE](https://github.com/unofficalcats/Cats-Blender-Plugin-Unofficial-)!
#### Avatar Toolkit is in Alpha and will contain issues, please ensure you report them!
Avatar Toolkit is a modern, Blender addon designed to streamline the process of preparing 3D avatars for virtual platforms including VRChat, ChilloutVR, Resonite, and other similar applications.
## What is Avatar Toolkit?
Avatar Toolkit simplifies the workflow for avatar creation and optimization by providing an all-in-one solution that:
- Automates complex optimization processes like mesh joining and vertex merging.
- Provides advanced tools for eye tracking setup and viseme configuration.
- Offers specialized armature utilities including bone name conversion for different platforms.
- Includes performance-focused optimization tools so you can optimize your avatar for platforms like VRChat and ChilloutVR.
The addon is built with a focus on user experience, reducing the number of steps needed to prepare avatars while offering powerful customization options for advanced users. Avatar Toolkit aims to be a complete replacement for Cats Blender Plugin and its unofficial variants, with a modern codebase designed specifically for current Blender versions and minimal dependencies on third-party plugins.
Join the Neoneko Discord here: https://discord.neoneko.xyz
Need a more stable toolset while Avatar Toolkit is in Alpha? Then please use Blender 4.x and use our Unofficial Cats Blender Plugin which you can find [here](https://github.com/unofficalcats/Cats-Blender-Plugin-Unofficial-).
### Support us:
If you like what we do and want to help support the development of cats you can do it on our pally.gg [here](https://pally.gg/p/teamneoneko) all money is split automatically between all developers and any support is appreciated.
## Blender version support policies.
You can find them on the wiki here [HERE](https://avatartoolkit.xyz/legacywiki.html?version=0.2.1#what-is-avatar-toolkits-version-support-policy)
## Features
See everything Avatar Toolkit has ot offer [here](https://avatartoolkit.xyz/legacywiki.html)
## Requirements
1) Blender Version
- Blender 4.5 or newer is required
- Blender 4.5 is the current recommended version
2) Python Requirements
- If using a custom Python installation with Blender, ensure NumPy is installed
- Default Blender installation includes all required packages
3) Recommended Setup
- Download Blender directly from https://blender.org
- Use Blender 4.5 for the best experience
#### Additional Plugins Requirements.
Currently None.
## Installation
You can find out how to install Avatar Toolkit [here](https://avatartoolkit.xyz/legacywiki.html?version=0.2.0#how-to-install-avatar-toolkit)
## Help
If you need help with Avatar Toolkit you can check the wiki (Coming soon).
## Acknowledgements
Avatar Toolkit is partly based on some code from Cats Blender Plugin and Cats Blender Plugin Unofficial, therefore we want to acknowledge the following people:
### Cats Code contributors:
- absolute quantum
- Hotox
- Shotariya
- Neitri
- Kiraver
- Jordo
- Ruubick
- Mysteryem
- 989onan
- Yusarina
## Feedback
Please open an issue if you need to leave feedback.