Skip to content

saturday06/VRM-Addon-for-Blender

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6,019 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

[ English / 日本語 ]

VRM Add-on for Blender CI status CodSpeed Badge

VRM Add-on for Blender adds VRM import, export, and editing capabilities to Blender. It also provides an API for automation via Python scripts.

Download

The steps vary depending on your Blender version and where you download from. Choose one of the following three methods.

Tutorials

Installation Create Simple VRM Create Humanoid VRM
Create Physics-Based Material Create Anime-Style Material VRM Animation
Automation with Python Scripts Development How-To

Overview

This add-on adds VRM-related functionality to Blender, including importing and exporting VRM files, adding VRM Humanoid, and configuring MToon shaders. Bug reports, feature requests, pull requests, and contributions are welcome. I have taken over development after Version 0.79 from the original author, @iCyP.

Development

The src/io_scene_vrm folder contains the main add-on code. By creating a symbolic link to this folder in Blender's user_default or addons directory, you can install the development source code as an add-on in Blender, making it easy to test changes efficiently.

For advanced development tasks such as running tests, refer to the development environment setup documentation.

How to create a development link for Blender 4.2 or later

Linux

blender_version=4.5
mkdir -p "$HOME/.config/blender/$blender_version/extensions/user_default"
ln -Ts "$PWD/src/io_scene_vrm" "$HOME/.config/blender/$blender_version/extensions/user_default/vrm"

macOS

blender_version=4.5
mkdir -p "$HOME/Library/Application Support/Blender/$blender_version/extensions/user_default"
ln -s "$PWD/src/io_scene_vrm" "$HOME/Library/Application Support/Blender/$blender_version/extensions/user_default/vrm"

Windows PowerShell

$blenderVersion = "4.5"
New-Item -ItemType Directory -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\extensions\user_default" -Force
New-Item -ItemType Junction -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\extensions\user_default\vrm" -Value "$(Get-Location)\src\io_scene_vrm"

How to create a development link for Blender 4.1.1 or earlier

Linux

blender_version=3.6
mkdir -p "$HOME/.config/blender/$blender_version/scripts/addons"
ln -Ts "$PWD/src/io_scene_vrm" "$HOME/.config/blender/$blender_version/scripts/addons/io_scene_vrm"

macOS

blender_version=3.6
mkdir -p "$HOME/Library/Application Support/Blender/$blender_version/scripts/addons"
ln -s "$PWD/src/io_scene_vrm" "$HOME/Library/Application Support/Blender/$blender_version/scripts/addons/io_scene_vrm"

Windows PowerShell

$blenderVersion = "3.6"
New-Item -ItemType Directory -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\scripts\addons" -Force
New-Item -ItemType Junction -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\scripts\addons\io_scene_vrm" -Value "$(Get-Location)\src\io_scene_vrm"

[ English / 日本語 ]

VRM Add-on for Blender CI status CodSpeed Badge

BlenderにVRM関連機能を追加するアドオンです。Pythonスクリプトによる自動化用のAPIも提供します。

ダウンロード

Blenderのバージョンやダウンロード元にあわせて手順が変わります。次の3種類の方式から選択してください。

チュートリアル

インストール方法 シンプルなVRMを作る 人型のVRMを作る
物理ベースのマテリアル設定 アニメ風のマテリアル設定 VRMアニメーション
Pythonスクリプトによる自動化 改造するには?

概要

BlenderにVRMのインポートやエクスポート、VRM Humanoidの追加やMToonシェーダーの設定などのVRM関連機能を追加するアドオンです。バグ報告、機能要望、Pull Request等歓迎します。バージョン 0.79以降の開発を作者である@iCyPさんから引き継ぎました。

改造するには

src/io_scene_vrm フォルダがアドオン本体です。 そのフォルダへのリンクをBlenderの user_default あるいは addons フォルダ内に作ることで、 開発中のソースコードをBlenderにアドオンとしてインストールした扱いにすることができ、 効率的に動作確認をすることができるようになります。

テストの実行など、より高度な開発をする場合は開発環境のセットアップ方法のドキュメントにあります。

Blender 4.2以上向けの、開発用リンクの作成方法

Linux

blender_version=4.5
mkdir -p "$HOME/.config/blender/$blender_version/extensions/user_default"
ln -Ts "$PWD/src/io_scene_vrm" "$HOME/.config/blender/$blender_version/extensions/user_default/vrm"

macOS

blender_version=4.5
mkdir -p "$HOME/Library/Application Support/Blender/$blender_version/extensions/user_default"
ln -s "$PWD/src/io_scene_vrm" "$HOME/Library/Application Support/Blender/$blender_version/extensions/user_default/vrm"

Windows PowerShell

$blenderVersion = "4.5"
New-Item -ItemType Directory -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\extensions\user_default" -Force
New-Item -ItemType Junction -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\extensions\user_default\vrm" -Value "$(Get-Location)\src\io_scene_vrm"

Blender 4.2未満向けの、開発用リンクの作成方法

Linux

blender_version=3.6
mkdir -p "$HOME/.config/blender/$blender_version/scripts/addons"
ln -Ts "$PWD/src/io_scene_vrm" "$HOME/.config/blender/$blender_version/scripts/addons/io_scene_vrm"

macOS

blender_version=3.6
mkdir -p "$HOME/Library/Application Support/Blender/$blender_version/scripts/addons"
ln -s "$PWD/src/io_scene_vrm" "$HOME/Library/Application Support/Blender/$blender_version/scripts/addons/io_scene_vrm"

Windows PowerShell

$blenderVersion = "3.6"
New-Item -ItemType Directory -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\scripts\addons" -Force
New-Item -ItemType Junction -Path "$Env:APPDATA\Blender Foundation\Blender\$blenderVersion\scripts\addons\io_scene_vrm" -Value "$(Get-Location)\src\io_scene_vrm"