@volter/blender-engine 0.1.148 → 0.1.149

package/browser/addons/vrm/documentation/en-us/index.md

@@ -0,0 +1,41 @@
+---
+title: VRM Add-on for Blender
+description: VRM Add-on for Blender adds VRM import, export, and editing capabilities to Blender.
+aside: false
+outline: false
+prev: false
+next: false
+---
+
+![](top.png){.logo}
+
+VRM Add-on for Blender adds VRM import, export, and editing capabilities to
+Blender. It supports Blender versions 2.93 to 5.2. It also provides
+[an API for automation via Python scripts](scripting-api/).
+
+## Download {#download}
+
+- For Blender 4.2 or later, please download and install it by following
+  [the instructions here](installation/#installation-methods).
+- For Blender 2.93 to 4.1: <DownloadLink />\
+  <small>[Past Releases](https://github.com/saturday06/VRM-Addon-for-Blender/releases)</small>
+- [Python package on PyPI (bpy-vrm-format)](https://pypi.org/project/bpy-vrm-format/)
+
+## Tutorials
+
+| [Installation](installation/)                                      | [Create Simple VRM](create-simple-vrm-from-scratch/)                         | [Create Humanoid VRM](create-humanoid-vrm-from-scratch/)                         |
+| ------------------------------------------------------------------ | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| [![](/assets/images/installation.gif){.tutorial}](installation/)   | [![](/assets/images/simple.gif){.tutorial}](create-simple-vrm-from-scratch/) | [![](/assets/images/humanoid.gif){.tutorial}](create-humanoid-vrm-from-scratch/) |
+| [Create Physics Based Material](material-pbr/)                     | [Create Anime Style Material](material-mtoon/)                               | [VRM Animation](animation/)                                                      |
+| [![](/assets/images/material_pbr.gif){.tutorial}](material-pbr/)   | [![](/assets/images/material_mtoon.gif){.tutorial}](material-mtoon/)         | [![](/assets/images/animation.gif){.tutorial}](animation/)                       |
+| [Automation with Python scripts](scripting-api/)                   | [Development How-To](development/)                                           |                                                                                  |
+| [![](/assets/images/scripting_api.gif){.tutorial}](scripting-api/) | [![](/assets/images/development.gif){.tutorial}](development/)               |                                                                                  |
+
+## Overview
+
+This add-on adds VRM-related functions to Blender, such as importing and
+exporting VRM, adding VRM Humanoid and setting MToon shaders. Bug reports,
+feature requests, pull requests, etc. are welcome. I have taken over the
+development after
+[Version 0.79](https://github.com/iCyP/VRM_IMPORTER_for_Blender2_8/releases/tag/0.79)
+from the author, [@iCyP](https://github.com/iCyP).

package/browser/addons/vrm/documentation/en-us/installation/index.md

@@ -0,0 +1,152 @@
+---
+title: "Add-on Installation"
+description: "Step-by-step installation guide for VRM Add-on for Blender."
+---
+
+This tutorial explains how to install VRM Add-on for Blender.
+
+![](/assets/images/installation.gif)
+
+The steps vary depending on your Blender version and where you download from.
+Choose one of the following methods. {#installation-methods}
+
+- [Blender 4.2 or later, download from Blender Preferences](#installation-4.2-or-later-online)
+- [Blender 4.2 or later, download from a web browser](#installation-4.2-or-later-offline)
+- [Blender 2.93 to 4.1](#installation-2.93-to-4.1)
+- [Python package on PyPI (bpy-vrm-format)](https://pypi.org/project/bpy-vrm-format/)
+
+## Blender 4.2 or later, download from Blender Preferences <a id="installation-4.2-or-later-online"/> {#installation-4.2-or-later-online}
+
+In Blender 4.2 and later, you can download and install from the Preferences
+window. When updates are available, you can also update by clicking a button in
+the Preferences window.
+
+Start Blender, then select `Edit` → `Preferences` from the menu.
+
+![](10.png)
+
+In the Preferences window, select `Get Extensions` from the left menu.
+
+If you see a message saying that installing or updating online extensions
+requires internet access, click `Allow Online Access`.
+
+![](11.png)
+
+> [!TIP]
+> Clicking `Allow Online Access` lets Blender communicate with the internet. If
+> you do not want to allow this, install via
+> [Blender 4.2 or later, download from a web browser](#installation-4.2-or-later-offline).
+
+After a moment, the "Available" list appears. Find the `VRM format` entry. If
+the list is long, you can filter it by typing `VRM` into the search box at the
+top.
+
+![](12.png)
+
+Click `Install` to complete the installation.
+
+![](13.png)
+
+If nothing appears in the list, online access may be disabled. In the
+Preferences window, select `System`, turn on `Allow Online Access`, then select
+`Get Extensions` again.
+
+![](14.png)
+
+If it still does not appear, check your internet access. Blender’s online
+services might also be down. You can check the status at
+https://status.blender.org/status/public.
+
+## Blender 4.2 or later, download from a web browser <a id="installation-4.2-or-later-offline"/> {#installation-4.2-or-later-offline}
+
+If you want to keep Blender’s online access disabled, download the add-on file
+in a web browser and add it from the Preferences window. First, open the
+[Blender Extensions Platform](https://extensions.blender.org/add-ons/vrm/).
+
+![](20.png)
+
+Click the `Get Add-on` button.
+
+![](21.png)
+
+A `download` link appears. Click it to download the add-on file.
+
+> [!TIP]
+> The downloaded add-on file is a ZIP file, but <u>please do not unzip it</u>,
+> as the unzipped data will not function as an add-on.
+
+> [!INFO]
+> You can also install by following the `Drag and Drop into Blender` instruction
+> on the website, but that requires allowing Blender online access.
+
+Next, start Blender and select `Edit` → `Preferences` from the menu.
+
+![](10.png)
+
+In the Preferences window, select `Add-ons` from the left menu, then click the
+`˅` button in the top right and choose `Install from Disk` from the menu.
+
+![](22.png)
+
+A file picker opens. Select the add-on file you downloaded earlier, confirm the
+filename ends with `.zip`, then click `Install from Disk`.
+
+![](23.png)
+
+If `VRM format` is added to the list and its checkbox is `on`, installation is
+complete.
+
+![](24.png)
+
+If the checkbox is `off`, turn it `on` manually.
+
+If `VRM format` is not added to the list, confirm the following:
+
+- The add-on file you downloaded is a ZIP file, but <u>you did not unzip it</u>.
+- The selected add-on filename ends with `.zip`.
+
+## Blender 2.93 to 4.1 <a id="installation-2.93-to-4.1"/> {#installation-2.93-to-4.1}
+
+Download latest add-on file from <DownloadLink />
+
+> [!TIP]
+> The downloaded add-on file is a ZIP file, but <u>please do not unzip it</u>,
+> as the unzipped data will not function as an add-on.
+
+Start Blender and select menu `Edit` → `Preferences`.
+
+![](1.png)
+
+Select `Add-ons` from the left menu when the preferences screen, and then press
+the `Install` button in the upper right corner.
+
+![](2.png)
+
+When the File View window appears, select the add-on file you just downloaded,
+make sure the filename ends with `.zip`, and press the `Install Add-on` button.
+
+![](3.png)
+
+Make sure `Community` is enabled.
+
+![](4.png)
+
+Find `Import-Export: VRM format` in the add-on list view.
+
+![](5.png)
+
+There is a search box in the upper right corner if there are too many items to
+find.
+
+![](6.png)
+
+If you cannot find it, please make sure that all of the following conditions are
+met
+
+- The add-on file you downloaded is a ZIP file, but <u>you did not unzip it</u>.
+- The selected add-on filename ends with `.zip`.
+- `Community` at the top of the window is enabled.
+
+Press the checkbox to complete the installation of the add-on.
+
+![](7.png)

package/browser/addons/vrm/documentation/en-us/material-mtoon/index.md

@@ -0,0 +1,122 @@
+---
+title: "Create Anime Style Material"
+description: "Set up an anime-style material with MToon shaders."
+---
+
+Set an anime-style material to VRM.
+
+![](/assets/images/material_mtoon.gif)
+
+Please refer to the VRM documentation for detailed configuration items
+
+https://vrm.dev/en/univrm/shaders/shader_mtoon
+
+After starting Blender, delete the cube that is displayed from the beginning.
+First, select the cube by left-clicking on it.
+
+![](1.png)
+
+When selected, the cube will turn orange around it. In this state, press the `x`
+key on your keyboard.
+
+![](2.png)
+
+Press the `Enter` key on the keyboard to confirm the deletion.
+
+![](3.png)
+
+If successful, the cube will be deleted. Next, add a sphere. With the cursor in
+the 3D viewport, hold down the `Shift` key on your keyboard and press the `a`
+key. The Add Object menu will appear, select `Mesh` → `UV Sphere`.
+
+![](4.png)
+
+Success is indicated when a sphere consisting of a square surface is displayed.
+
+![](5.png)
+
+Next, smooth the surface of this sphere to make it more spherical. Click on the
+`Object` menu at the top of the screen and select `Shade Smooth` from there.
+
+![](6.png)
+
+It is successful when the corners are removed and the sphere looks like a smooth
+sphere.
+
+![](7.png)
+
+Next, we can check the color of the material.
+
+With the cursor in the 3D viewport, press the `z` key on the keyboard to bring
+up the preview display selection menu. Then move the mouse down and select
+`Rendered`.
+
+![](8.png)
+
+If successful, the direction of the unlit areas will change. However, there is
+little change in the display, but note that the coloring is not reflected in the
+display if the default setting is used.
+
+Next, set the view transformation settings. Select the tab with the
+"![](/assets/images/scene_property_tab_icon.png)" icon in the lower right
+corner, then go to `Color Management` and set `View Transform` to `Standard`.
+
+![](9.png)
+
+The sphere will be slightly brighter. If the default is left unchanged, the
+color displayed will be darker than the specified color.
+
+Next, configure the material settings. Select the tab with the
+"![](/assets/images/material_property_tab_icon.png)" icon in the lower right
+corner and press the `New` button.
+
+![](10.png)
+
+A material named `Material.001` will be added. Then scroll down the view and
+under `VRM Material` check the `Enable VRM MToon Material` checkbox.
+
+![](11.png)
+
+The display color of the sphere turns white and the VRM anime-style material
+setting item appears.
+
+![](12.png)
+
+As a sample setup, set the following
+
+- Set the `Lit Color, Alpha` to light blue
+- Set the `Shade Color` to blue
+- Set the `Shading Toony` to 1
+- Set the `Shading Shift` to 0
+
+![](13.png)
+
+Scroll the display and set the `Outline` item to `World Coordinates`.
+
+![](14.png)
+
+When the outline settings appear, set the following as a sample setting. (This
+outline display is only compatible with Blender 3.5 or later and 3.3)
+
+- Set the `Outline Width` to 0.03
+- Set the `Outline Color` to white
+- Set the `Outline LightingMix` to 0
+
+![](15.png)
+
+Save this model as a VRM. Select `File` → `Export` → `VRM (.vrm)` from the menu.
+
+![](16.png)
+
+Enter the filename and destination when the File View window appears and press
+`Export VRM`.
+
+![](17.png)
+
+If successful, the VRM file will be saved to the specified location.
+
+![](/assets/images/material_mtoon.gif)
+
+You can check the operation on this page.
+
+- https://hub.vroid.com/en/characters/2368193253669776229/models/7692418309335351071

package/browser/addons/vrm/documentation/en-us/material-pbr/index.md

@@ -0,0 +1,94 @@
+---
+title: "Create Physics Based Material"
+description: "Set up physics-based materials using Principled BSDF shaders."
+---
+
+Set up realistic physics-based materials for VRM.
+
+![](/assets/images/material_pbr.gif)
+
+In VRM Add-on for Blender, realistic physics-based material settings are handled
+exactly the same way as in Blender's glTF 2.0 add-on. Please refer to the
+appropriate documentation for more information.
+
+https://docs.blender.org/manual/en/2.93/addons/import_export/scene_gltf2.html#exported-materials
+
+After starting Blender, delete the cube that is displayed from the beginning.
+First, select the cube by left-clicking on it.
+
+![](1.png)
+
+When selected, the cube will turn orange around it. In this state, press the `x`
+key on your keyboard.
+
+![](2.png)
+
+Press the `Enter` key on the keyboard to confirm the deletion.
+
+![](3.png)
+
+If successful, the cube will be deleted. Next, add a sphere consisting of
+triangles. With the cursor in the 3D viewport, hold down the `Shift` key on your
+keyboard and press the `a` key. The Add Object menu will appear, select `Mesh` →
+`Ico Sphere`.
+
+![](4.png)
+
+If successful, a sphere consisting of triangles is added.
+
+![](5.png)
+
+Next, we can check the color of the material.
+
+With the cursor in the 3D viewport, press the `z` key on the keyboard to bring
+up the preview display selection menu. Then move the mouse down and select
+`Material Preview`.
+
+![](6.png)
+
+If successful, the grayish color of the display will increase. However, there is
+little change, but note that the coloring is not reflected in the display if the
+default is used.
+
+![](7.png)
+
+In this state, set the material settings. Select the tab with the
+"![](/assets/images/material_property_tab_icon.png)" icon in the lower right
+corner and press the `New` button.
+
+![](8.png)
+
+A material named `Material.001` will be added. Also make sure that the `Surface`
+setting is set to `Principled BSDF`.
+
+![](9.png)
+
+By setting the `Principled BSDF`, you can configure realistic physics-based
+texture settings, which can then be exported directly to VRM.
+
+![](10.png)
+
+Then select `Base Color` and enter blue when the color selection pop-up appears.
+
+![](11.png)
+
+Then set the value of `Metallic` to `0.5`.
+
+![](12.png)
+
+Save this model as a VRM. Select `File` → `Export` → `VRM (.vrm)` from the menu.
+
+![](13.png)
+
+Enter the filename and destination when the File View window appears and press
+`Export VRM`.
+
+![](14.png)
+
+If successful, the VRM file will be saved to the specified location.
+
+![](/assets/images/material_pbr.gif)
+
+You can check the operation on this page.
+
+- https://hub.vroid.com/en/characters/3819557420301868457/models/3988362170085862123