Merge branch 'master' into MISSINGNO

.gitignore

@@ -15,6 +15,7 @@
 .env.test.local
 .env.production.local
 
+
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
@@ -29,3 +30,7 @@ yarn-error.log*
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
+
+# Obsidian
+.obsidian
+_obsidian_database_.md

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

.yarnrc.yml

@@ -1,2 +1,3 @@
 enableGlobalCache: false
-nodeLinker: node-modules
+
+nodeLinker: node-modules

README.md

@@ -1,117 +1,24 @@
 
 # Warudo Handbook
 
+![Warudo handbook](https://docs.warudo.app/doc-img/intro-cover.jpg)
+
 Welcome to the [Warudo Handbook](https://docs.warudo.app/)!
 
-Warudo Handbook is offical ultimate guide for powerful 3D VTubing software [Warudo](https://warudo.app/)! The main purpose of this repository is to provide comprehensive beginner-friendly yet in-depth enough document for [Warudo App](https://warudo.app/).
+Warudo Handbook is offical ultimate guide for powerful 3D VTubing software [Warudo](https://warudo.app/)!   
+The main purpose of this repository is to provide comprehensive beginner-friendly yet in-depth enough document for [Warudo App](https://warudo.app/).
 
-We using [Docusaurus](https://docusaurus.io/) to create website which is maked by JavaScript Markdown and so much more great staffs.
+The Warudo handbook proudly uses using [Docusaurus](https://docusaurus.io/) to create website which is maked by JavaScript Markdown and so much more great staffs.
 
-## Commands
+## Getting started
+[https://docs.warudo.app/](https://docs.warudo.app/)
 
-`yarn` Install dependencies  
-`yarn start:en` Start EN version  
-`yarn start:zh` Start ZH version  
-`yarn start:all` Start multi-version at different port  
-`yarn build` Build site
+## Issues / Feedback / Suggestions / Report bug
 
+Any suggestions or questions about Warudo Handbook, feel free to create issues on GitHub.  
+https://github.com/HakuyaLabs/warudo-docs/issues
 
-## Running local development site
-
-If you are not familiar with dev staff, don't worry, let's get start.
-
-### Prepare environment
-
-First, download the runtime. 
-
- - Node.js download: https://nodejs.org/en/download/  
-	Node.js is the programming language we used.  
-	Select LTS version - installer (.msi/.exe for Windows, .pkg for macOS).
-
- - GitHub Desktop download: https://desktop.github.com/  
-    GitHub Desktop is a great version control software for us to manage and commit changes.
-
- - VSCode download: https://code.visualstudio.com/  
-	VSCode is a common editor that works great for front-end sites like this one, you can also use other text editors.
-
-### Using command line
-
-For Windows, use `Win+R` and enter `cmd` to open the terminal.
-
-For macOS, use the `Terminal` app in your lunchpad.
-
-After installation, you should able to use the `node -v` command to see node.js version on the terminal.
-
-### Set up the project using GitHub desktop
-
-Login Github account
-
-Search for `HakuyaLabs/warudo-doc` 
-
-Clone project  
-Then the project has been downloaded to your computer.
-
-Click `Current branch` - `New branch` - input name - `Create branch`    
-So that you can edit files in your independent branch.
-
-Click `Publish branch`  
-Event one should see your branch and you are ready to start edit.
-
-### Run local site
-
-Open the terminal.
-
-**`cd <path_for_your_dev_folder>`**  
-Jump into the folder where we place site files.
-
-> Tips: You can check Github desktop app OR drag & drop the folder to the terminal window for easily get the project path. In VSCode or a similar editor, you can also use the in-app terminal to run commands.
-
-**`corepack enable`**   
-That set up package manager we used for node.js.  
-*Usually you just need run this command once.*
-
-**`yarn`**  
-Install dependencies.  
-*When project dependencies (package.json) updated, re-run this command is necessary.*
-
-**`yarn start:en`** Start EN version  
-**`yarn start:zh`** Start ZH version  
-**`yarn start:all`** Start multi-version at different port  
-
-Then you are all set, you can view local site on your machine!  
-When you change and save the docs, the browser will automatic refresh.  
-Try it out, and go ahead start editing document files!  
-
-### Start editing
-
-For the English version, docs are located at `/docs`.  
-For the Chinese version, docs are located at `/i18n/zh/docusaurus-plugin-content-docs/current`.  
-
-Non-English version files should be exactly the same structure as the English version so that the language switch can work accurately.  
-
-> Tips: The navigation bar on the left side is also generated by English version files, 
-> It's recommended to copy every file in `/docs` folder to `/i18n/[lang]/docusaurus-plugin-content-docs/current` and make sure that every file aligns in a different language.
-
-Most document files are saved as .md or .mdx, known as [Markdown](https://www.markdownguide.org/) files,   
-which is just plain text with some formate code in it.
-
-### Commit & Upload your changes
-
-After saving all the files that you changed.   
-
-Open the Github desktop, then you can see all the changes on the left side.  
-Check all the changed files you want to commit.  
-Enter a summary, and click `Commit`.  
-
-You have committed your changes and you should see it in the `History` panel.  
-
-But it is just on your computer right now.  
-To publish to Github, click `Push Origin`.  
-
-Yay! Everyone should see it online, and you can let everyone know.
-
-### Deploy your changes
-
-All the changes will be reviewed merged into the master and then published to the website.  
-Contact the reviewer on Discord or QQ for the next step. 
+## Contribution
 
+Contribution guide  
+https://docs.warudo.app/docs/misc/handbook-contribution

docs/README.md

@@ -14,7 +14,7 @@ Warudo is an avatar animation software specifically designed for 3D VTuber lives
 
 Warudo is a comprehensive, feature-packed 3D VTubing software designed for both casual and professional users. It offers support for [a wide variety of motion capture systems](mocap/overview.md), so you can both stream at home or at a professional mocap studio. It also offers a wide range of features, including posing your character with 500+ idle animations, integration with livestreaming platforms, a node-based visual scripting system, and many more.
 
-Warudo is also extremely customizable. It provkides a Mod SDK for importing any Unity-compatible 3D assets, and a C# scripting SDK for those inclined to develop custom features, making it versatile for both users and developers.
+Warudo is also extremely customizable. It provides a [Mod SDK](modding/mod-sdk.md) for importing any Unity-compatible 3D assets, and a [C# scripting SDK](scripting/overview.md) for those inclined to develop custom features, making it versatile for both users and developers.
 
 Here are just a few cool examples from the Warudo community:
 
@@ -31,10 +31,10 @@ For non-streaming activities, Warudo can be used for **free**. For example, test
 
 For streaming activities, Warudo can be used for **free** if and only if:
 
-* the copyrights of your VTubing persona are exclusively yours, and you possess ownership of your accounts on social/livestreaming platforms;
+* the copyrights of your VTuber IP (Intellectual Property) are exclusively yours, and you possess ownership of your accounts on social/livestreaming platforms;
 * there are no contractual obligations requiring you to stream for X hours per week, unless such a contract is directly in agreement with a major livestreaming platform (e.g., Twitch, YouTube).
 
-If you are not sure, please contact us at [[email protected]](mailto:[email protected]).
+Note that you _can_ still own full copyrights of your VTuber IP even if you use a non-exclusive VTubing model, such as a VRChat public avatar. If you are not sure, please contact us at [[email protected]](mailto:[email protected]).
 
 ## I am a corporate VTuber. How can I use Warudo?
 
@@ -43,3 +43,11 @@ You can evaluate and test the Steam version of Warudo for as long as you like. H
 ## I have other questions!
 
 Please contact us at [[email protected]](mailto:[email protected]), or join our [Discord](https://discord.gg/warudo).
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/anchor.md

@@ -14,3 +14,11 @@ Some blueprint nodes also allow you to specify an anchor as the origin or destin
 ## Setup
 
 To set up an anchor, first set the **Attach To** option if you want the anchor to be attached to a character or prop. Then, use the transform gizmos to move and rotate the anchor, so that it is in the desired position.
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/camera.md

@@ -277,3 +277,11 @@ Add a mosaic effect to the image!
 <p class="img-desc">Pixelate enabled.</p>
 </div>
 </div>
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/character.md

@@ -155,7 +155,7 @@ After
 </div>
 :::
 
-The **Bend Goal Target** and **Bend Goal Weight** options can be used to control the rotation of the elbows and knees. The **Bend Goal Target** is usually an [anchor](../anchor.md).
+The **Bend Goal Target** and **Bend Goal Weight** options can be used to control the rotation of the elbows and knees. The **Bend Goal Target** is usually an [anchor](anchor.md).
 
 <div style={{display: 'flex', justifyContent: 'space-between', gap: '1rem'}}>
 <div>
@@ -194,6 +194,10 @@ Note that models exported by [VRoid Studio](https://vroid.com/en/studio) only ha
 To toggle meshes in blueprints, you can use the **Toggle Character Meshes** node.
 :::
 
+## Scaling
+
+You can scale the character by using the **Transform → Scale** property. However, this may break features such as ragdoll, IK, and compatibility with some motion capture systems (e.g., [Leap Motion](../mocap/leap-motion)). If you need to scale the character, we recommend to scale the character in the 3D modeling software instead, i.e., before you have imported the model into Unity or Warudo.
+
 ## Frequently Asked Questions {#FAQ}
 
 ### How can I trigger an expression automatically with face tracking?
@@ -230,3 +234,11 @@ The following changes the hotkey to Ctrl+Shift+T.
 To do this, enable **Is Transient** on the **Toggle Character Expression** node in the **Expression Key Bindings** blueprint. The duration of the expression will be determined by **Exit Delay** of each BlendShape in the expression.
 
 ![](/doc-img/en-expression-5.webp)
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/director.md

@@ -123,3 +123,11 @@ Enables collision detection for the camera, so that the camera will not go throu
 ## Global Offsets
 
 The **Global Offsets** section allows you to specify global offsets for all virtual cameras, including **Camera Animation Speed**, **Field Of View**, **Position**, **Orientation**, and **Zoom**. This can be especially useful for implementing effects such as zooming in and out based on audio volume, regardless of which virtual camera is currently active.
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/environment.md

@@ -35,3 +35,11 @@ Although you are allowed to move and rotate the environment, it is not recommend
 ## Override Environment Settings
 
 You can override the environment settings such as **Ambient Lighting Source**, **Environment Reflections Intensity**, etc. Note that not all these settings are supported by all environments; for example, if an environment use baked lighting, then **Ambient Lighting Source** will be ignored.
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/keyboard.md

@@ -16,3 +16,11 @@ To use keyboard/trackpad, simply enable **Use Keyboard/Trackpad** during the mot
 :::info
 Currently, keyboard/trackpad are only supported for upper body tracking setups.
 :::
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/lights.md

@@ -29,3 +29,11 @@ When you are using an [environment](environment), we recommend turning off **Env
 ### Shadow
 
 You can enable **Shadow** to make the light cast shadows. Note that in order to cast a character's shadow on the environment (e.g., the floor), you need to enable **Main Properties → Affect Environment**.
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />

docs/assets/motion-player.md

@@ -19,3 +19,11 @@ Currently, only WANIM animations are supported. Support for FBX and BVH animatio
 Select the **Character** that you would like to play the animation on. Select the **Animation** that you would like to play, and click the **Play** button to start playing the animation. You can loop the animation by enabling **Loop**.
 
 You can exclude certain bones from the animation by adding them to the **Excluded Body Parts** or **Excluded Bones** list.
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />