V-Sekai/godot-vrm V-Sekai/godot-vrm

  • Stars
    star
    286
  • Rank 144,690 (Top 3 %)
  • Language GDScript
  • License
    Other
  • Created about 4 years ago
  • Updated about 2 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
V-Sekai/godot-vrm
github

V-Sekai

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Importer/Exporter for VRM avatars and MToon shader. Available for Godot 4.1+ and 3.2+ in the Asset Library.

VRM addon for Godot Engine

This Godot addon fully implements an importer for models with the VRM specification, version 0.0. Compatible with Godot Engine 4.0 stable or newer.

Proudly brought to you by the V-Sekai team.

This package also includes a standalone full implementation of the MToon Shader for Godot Engine.

Example of VRM Addon used to import two example characters

IMPORT support for VRM 0.0 is fully supported. Retargeting for animation currently requires an external script.

What is VRM?

See https://vrm.dev/en/ (English) or https://vrm.dev/ (日本語)

"VRM" is a file format for handling 3D humanoid avatar (3D model) data for VR applications. It is based on glTF 2.0. Anyone is free to use it.

What VRM Specification features are currently supported in Godot Engine?

  • vrm.blendshape
    • binds / blend shapes: implemented (Animation tracks)
    • material binds: implemented (Animation tracks)
  • vrm.firstperson
    • firstPersonBone: implemented (Metadata)
    • meshAnnotations / head shrinking: implemented (Animation method track TODO_scale_bone)
    • lookAt: implemented (Animation tracks)
  • vrm.humanoid
    • humanBones: implemented (Metadata dictionary)
    • Unity HumanDescription values: unsupported
    • Automatic mesh retargeting: planned
    • humanBones renamer: planned
  • vrm.material
    • shader
      • VRM/MToon: fully implemented
      • VRM/UnlitTransparentZWrite: fully implemented
      • VRM_USE_GLTFSHADER with PBR: fully implemented
      • VRM_USE_GLTFSHADER with KHR_materials_unlit: fully implemented
      • legacy UniVRM shaders (VRM/Unlit*): supported
      • legacy UniGLTF shaders (UniGLTF/UniUnlit, Standard): uses GLTF material
    • renderQueue: implemented (maps to render_priority; not consistent between models)
    • floatProperties, vectorProperties, textureProperties: implemented
  • vrm.meta (Metadata, including License information and screenshot): implemented
  • vrm.secondaryanimation (Springbone)
    • boneGroups: fully implemented (engine optimization patch is recommended)
    • colliderGroups: implemented (engine optimization patch is recommended)

EXPORT is completely unsupported. Support will be added using the Godot 4.x GLTF Export feature in the future

Godot 4.x

VRM works in latest Godot master.

Caveat: Scenes with realtime omni or spot lights will have clustering artifacts, because there is no current way to detect if a given light is directional. After some missing variables are added, we can provide a way to detect this.

Godot 3.x

For VRM compatible with Godot Engine 3.2.2 or later, use the godot3 branch of this repository.

https://github.com/V-Sekai/godot-vrm

How to use

Install the vrm addon folder into addons/vrm. MUST NOT BE RENAMED: This path will be referenced by generated VRM meta scripts.

Install Godot-MToon-Shader into addons/Godot-MToon-Shader. MUST NOT BE RENAMED: This path is referenced by generated materials.

Install the godot_gltf GDNative helper into addons/godot_gltf. MUST NOT BE RENAMED: The GDNative C++ code also hardcodes this path.

Enable the VRM and MToon plugins in Project Settings -> Plugins -> VRM and Godot-MToon-Shader.

Credits

Thanks to the V-Sekai team and contributors:

For their extensive help testing and contributing code to Godot-VRM.

Special thanks to the authors of UniVRM, MToon and other VRM tooling

More Repositories

1

unidot_importer

Import .unitypackage and other assets designed for Unity Engine as a GDScript addon for vanilla Godot 4.x
GDScript
542
star
2

v-sekai-game

Open-source VR socials
GDScript
130
star
3

godot-whisper

An GDExtension addon for the Godot Engine that enables realtime audio transcription, supports OpenCL for most platforms, Metal for Apple devices, and runs on a separate thread.
Metal
54
star
4

godot-blender

GDScript
33
star
5

many_bone_ik

A custom inverse kinematics system solver for multi-chain skeletons and with constraints.
C++
32
star
6

TOOL_model_explorer

🌟 View models, materials & animations. Quick texture view & wireframe mode. Supports .vrm, .glb, .gltf.
GDScript
19
star
7

godot-usd

GDScript
18
star
8

manuals

Manuals for V-Sekai
C
17
star
9

Godot-MToon-Shader

Port of MToon to Godot Engine
GDScript
15
star
10

blender-skeletal-motion-animate

This plugin lets you re-target animations.
Python
12
star
11

cassie

Sketch complex curves and surfaces in VR
C#
10
star
12

three-vrm-1-sandbox-mixamo

This is an example of reading the motion capture data from Mixamo and running it through three-vrm to create a virtual character.
JavaScript
10
star
13

awesome-v-sekai

Awesome list of V-Sekai involved projects
9
star
14

preconditioner-for-cloth-and-deformable-body-simulation

Botao Wu, Zhendong Wang and Huamin Wang. 2022. A GPU-Based Multilevel Additive Schwarz Preconditioner for Cloth and Deformable Body Simulation. ACM Transactions on Graphics (SIGGRAPH), vol. 41, no. 4, pp. 63:1--63:14
C++
9
star
15

iree.gd

Moved to https://github.com/iree-gd/iree.gd
C++
9
star
16

godot-bvh

GDScript
8
star
17

V-Sekai.blender-game-tools

A Blender addons repostory for V-Sekai
Python
8
star
18

uro

Provides functionality needed to run your V-Sekai backend. It will serve custom game content, support content caching, and provide a user authentication system
Elixir
7
star
19

godot-goal-task-planner

C++
6
star
20

godot-ufbx

C++
6
star
21

avatar_vr_demo

Minimalist test project designed for tuning VR player controllers and avatar IK
GDScript
6
star
22

world

C++
6
star
23

godot-msdf-project

A project for Godot Engine to prototype multichannel signed distance fields (MSDF)
5
star
24

godot-libsql

A custom Godot Engine module to use the sqlite relational database
C++
5
star
25

godot-point-cloud-multistroke-recognizer

GDScript
5
star
26

godot-sentry-native

Godot C++ Custom Module to report crashes and errors to Sentry.io
C++
5
star
27

godot-llama

Metal
5
star
28

TOOL_cloth_dynamics

C++
4
star
29

godot_xr_vignette

XR Tunneling shader for Godot Engine
GDScript
4
star
30

godot-gltf-sandbox

Godot gltf sandbox for extensions
GDScript
4
star
31

godot-spatial-audio-project

Open source project for testing spatial audio in games with Godot Engine
4
star
32

godot_motion_matching

Pre-release port of https://github.com/Remi123/MotionMatching to a C++ module
C++
4
star
33

mvsqlite

Distributed, MVCC SQLite that runs on FoundationDB.
C
4
star
34

godot-network-rollback

Fork of Snopek's Rollback Netcode
GDScript
3
star
35

blog

Public media related to the V-Sekai community
3
star
36

virtual_keyboard

A gdscript Godot Engine addon that lets you use a virtual keyboard
GDScript
3
star
37

godot-matrix

Mirror of gitlab.com/vurpo/godot-matrix.
C++
3
star
38

emote_theme

Minimalist theme generator for the Godot Engine.
GDScript
3
star
39

godot_network_demo

Testbed project for experimenting with Godot 4's new built-in network replication stack
GDScript
3
star
40

godot-blue-zinc-pelican-character-generator

GDScript
3
star
41

ANIM_mmd_vrm_sample

A project for Godot Engine to test animation import from MMD
GDScript
3
star
42

groups-gocd-pipelines

A repo for both build and export GOCD pipelines. To update: edit jsonnet/godot.jsonnet and run bin/generate.bat to regenerate the pipelines.
CUE
3
star
43

shader-motion-navy-lead-ostrich

ShaderMotion is a format that stores the animation in video format. This already provides a good way to record motion, but we want the ability to play it back in Godot Engine onto a character.
JavaScript
3
star
44

godot-hop-dance

GDScript
3
star
45

lasso

A custom Godot Engine module designed to make the task of selecting objects in VR where they may be unevenly distributed in 3d space and the user may have bad aim or shaky hands much easier.
C++
3
star
46

vsk_avatar

vsk_avatar is a Godot Engine addon designed to provide a common V-Sekai interface to avatars
GDScript
3
star
47

groups_charts

A library of charts plotted in Control, 2D and 3D nodes to visualize general-purpose datasets for Godot Engine
GDScript
3
star
48

vsk_editor

Editor plugin for interfacing with the V-Sekai server for content uploading
GDScript
2
star
49

godot-cmark

Enables rich text labels with CommonMark support using the cmark library
C++
2
star
50

godot-modules-vrm

Godot 3.2 custom modules required for VRM support (requires git submodule update --init)
2
star
51

line_renderer

A gdscript addon for Godot Enginet to render lines
GDScript
2
star
52

root-motion-extractor

Custom post-import script functions and template for Godot for extracting specific root motion data from hips into skeleton
GDScript
2
star
53

xr-grid

V-Sekai.xr-grid is a VR interaction tool
GDScript
2
star
54

determinism_test

Test project for improving determinism of Godot's physics engine for purpose of improving state synchronisation.
GDScript
2
star
55

merge

Scripts for combining branches to create the Godot Groups branch
Shell
2
star
56

sar1_debug_manager

A gdscript Godot Engine addon to manage debug messages
GDScript
2
star
57

V-Sekai.blue-tin-fox-models

🦊 Blue Tin Fox Models: Get a collection of 3D characters, objects, lights & cameras for V-Sekai's block meshing setup! Perfect for game prototyping with open-source Blender .blend files.
Python
2
star
58

vsk_sdk

Collection of addons required for creating custom V-Sekai content in Godot
GDScript
2
star
59

math_util

A Godot Engine gdscript addon to provide some missing math functions
GDScript
2
star
60

groups-engine-workspace

Share the V-Sekai changes to Godot Engine and our custom modules
Batchfile
2
star
61

sar1_log_manager

A gdscript addon for Godot Engine to manage logging errors
GDScript
2
star
62

godot-skeleton-merge-tool

GDScript
2
star
63

godot-double-precision-test

GDScript
2
star
64

actor

Actor framework for Godot
GDScript
1
star
65

godot-golang

C++
1
star
66

godot_open_telemetry

C++
1
star
67

vsk_ui_demo

Experimental testbed for revised UI.
GDScript
1
star
68

blender_shader_motion_devon

C#
1
star
69

godot-htn-archived

C++
1
star
70

tutorial-mesh-to-vrm

1
star
71

godot-csg-manifold

C++
1
star
72

godot-flatbuffers

C++
1
star
73

vsk_exporter_example_addon

An example of how to create a Godot plugin with callbacks to the VSKExporter for preprocessing exported content.
GDScript
1
star
74

godot-osc-archived

C++
1
star
75

godot-3dc-sample

A project for Godot Engine to test GLTF2 3D commerence conformance
1
star
76

.github

V-Sekai is a community-run, self-hostable virtual reality platform. It's free and open source.
1
star
77

gd3to4

Python scripts to convert Godot 3.x code to Godot 4.x (currently master branch)
Python
1
star
78

shader-motion-video-to-anims

Python
1
star
79

workflow-maroon-steel-cat

Jsonnet
1
star
80

flux-config

A collection of flux configurations for deploying your V-Sekai Groups game server as well as the V-Sekai Uro backend.
1
star
81

godot-mvsqlite

C++
1
star
82

V-Sekai-faceless

A proof of concept open source driver for using VR controllers without an HMD. The goal is to guesstimate the position of the HMD based on the controller positions, so you can interact with the virtual world without needing to wear the HMD at all.
C++
1
star
83

vsk_importer_exporter

Addon for managing V-Sekai asset import and export pipeline
GDScript
1
star
84

avatar_collider_vr_demo

GDScript
1
star
85

elixir-mvsqlite

A mvsqlite driver for Elixir
C
1
star
86

V-Sekai.mediapipe-labeler

Python
1
star
87

elixir-libgodot

Elixir
1
star
88

vsk_map

Library for handling V-Sekai maps
GDScript
1
star
89

cassie-data

This repository contains the data from the CASSIE project, both raw data recorded directly from the VR sketching app, along with data that has been reformated and compacted for easier downstream analysis of the sketches.
HTML
1
star
90

godot-shape-cast

A gdscript test project for shape casting
GDScript
1
star
91

sar1_console_manager

GDScript
1
star
92

vsk_entities

Library for managing V-Sekai entity types
GDScript
1
star
93

sar1_vr_manager

Higher level interface to VR platforms
GDScript
1
star
94

vsk_vrm_avatar_tool

Tool to aid in conversion of VRM files into VSK-compatible avatars
GDScript
1
star
95

world_editor

The Godot Engine editor for the V-Sekai virtual worlds and socials
C++
1
star
96

vsona-discord-bot

V-Sona is a discord bot for communicating server status and managing community roles
Elixir
1
star
97

javascript-archive

A custom Godot engine module using QuickJS to provide Javascript language support
C++
1
star
98

V-Sekai.virtual_joystick_godot

A virtual joystick for touchscreens, for 3D games, with useful options.
GDScript
1
star
99

sample-webrtc-signaling

GDScript
1
star
100

godot-motion-player

GDScript
1
star