Skip to content

Commit 92d4310

Browse files
MushusMushus
committed
docs
1 parent dbeaf27 commit 92d4310

15 files changed

Lines changed: 5187 additions & 2 deletions

‎.github/workflows/deploy-docs.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
push:
9+
branches: [main]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
35+
- name: Setup Node
36+
uses: actions/setup-node@v4
37+
with:
38+
node-version: 20
39+
cache: npm
40+
- name: Setup Pages
41+
uses: actions/configure-pages@v4
42+
- name: Install dependencies
43+
run: npm install
44+
- name: Build with VitePress
45+
run: npm run docs:build
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: docs/.vitepress/dist
50+
51+
# Deployment job
52+
deploy:
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
needs: build
57+
runs-on: ubuntu-latest
58+
name: Deploy
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,7 @@ InitTestScene*.unity*
9999
/[Aa]ssets/[Ii]nit[Tt]est[Ss]cene*.unity*
100100
/Assets
101101
!/Assets/OpenFitter
102-
!/Assets/OpenFitter.meta
102+
!/Assets/OpenFitter.meta
103+
104+
/docs/.vitepress
105+
/docs/.vitepress/config.mts

‎README.md‎

Lines changed: 231 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,231 @@
1-
# OpenFitterUnityUI
1+
# OpenFitterUnityUI
2+
3+
[日本語](#japanese) | [English](#english)
4+
5+
<a name="japanese"></a>
6+
7+
## 概要
8+
9+
OpenFitterUnityUIは、3Dアバターモデルへの衣装の自動フィッティングを行うオープンソースのUnity Editorツールです。VRChatアバタークリエイターやアバター改変者が、異なる体型間で衣装を転送するための合理化されたワークフローを提供します。
10+
11+
Nine GatesのGPL-3ライセンスコンポーネントを基に構築されたOpenFitterUnityUIは、RBF（放射基底関数）変形とボーンポーズ転送を使用した複雑な衣装フィッティングプロセスを自動化する、使いやすいUnity Editorインターフェースを提供します。
12+
13+
## 機能
14+
15+
- **自動衣装フィッティング**: 異なる体型のアバター間で衣装を転送
16+
- **Unity Editor統合**: Unity内で直接動作する直感的なウィザードベースのインターフェース
17+
- **自動環境セットアップ**: Blender、Python依存関係、必要なアドオンを自動的にダウンロード・設定
18+
- **ブレンドシェイプ管理**: フィッティングプロセス中にカスタムブレンドシェイプを設定・保持
19+
- **進捗トラッキング**: フィッティング操作中のリアルタイム進捗監視
20+
- **データフォーマット互換性**: MochiFitterのデータフォーマットに対応
21+
22+
## 必要要件
23+
24+
- Unity 2022.3以降
25+
- Windows OS（Blender自動化のため）
26+
- インターネット接続（初期セットアップとダウンロードのため）
27+
- 約2GBの空きディスク容量（Blenderと依存関係のため）
28+
29+
## インストール
30+
31+
### 方法1: Unityパッケージ（推奨）
32+
33+
1. [GitHubリリース](https://github.com/Mushus/OpenFitterUnityUI/releases)から最新の`OpenFitterUnityUI.unitypackage`をダウンロード
34+
2. `Assets > Import Package > Custom Package`からUnityプロジェクトにパッケージをインポート
35+
3. `Tools > OpenFitter`にOpenFitterUnityUIメニューが表示されます
36+
37+
### 方法2: 手動インストール
38+
39+
1. このリポジトリをクローンまたはダウンロード
40+
2. `Assets/OpenFitter`フォルダをUnityプロジェクトの`Assets`フォルダにコピー
41+
3. Unityが自動的にエディタースクリプトをコンパイルします
42+
43+
## クイックスタート
44+
45+
1. Unity内で`Tools > OpenFitter`からOpenFitterウィンドウを開く
46+
2. セットアップウィザードに従います：
47+
- **環境セットアップ**: 「すべてインストール」をクリックして、Blenderと依存関係を自動的にセットアップ
48+
- **ソース選択**: ソースアバター（衣装を持つアバター）を選択
49+
- **ターゲット選択**: ターゲットアバター（衣装を受け取るアバター）を選択
50+
- **ブレンドシェイプ設定**: （オプション）保持するブレンドシェイプを設定
51+
- **実行**: フィッティングプロセスを実行
52+
3. プロセスが完了するまで待ち、出力を確認
53+
54+
詳細な手順については、[使い方ガイド](./docs/usage.md)を参照してください。
55+
56+
## ドキュメント
57+
58+
詳細なドキュメントは[docsディレクトリ](./docs/)にあります：
59+
60+
- **利用者向け**:
61+
- [セットアップガイド](./docs/setup.md) - インストールと初期設定
62+
- [使い方](./docs/usage.md) - 基本的な操作方法
63+
- [トラブルシューティング](./docs/troubleshooting.md) - よくある問題と解決方法
64+
- [ライセンス](./docs/license.md) - ライセンス情報
65+
66+
- **開発者向け**:
67+
- [開発ガイド](./docs/development/) - 開発環境のセットアップ
68+
- [アーキテクチャ](./docs/development/architecture.md) - システム設計
69+
- [コア技術](./docs/development/technology.md) - 使用技術
70+
- [プロジェクト構造](./docs/development/project-structure.md) - ファイル構成
71+
- [ビルド方法](./docs/development/building.md) - パッケージのビルド
72+
73+
### ドキュメントサイトの起動
74+
75+
```bash
76+
npm install
77+
npm run docs:dev
78+
```
79+
80+
[http://localhost:5173](http://localhost:5173)にアクセスしてドキュメントを閲覧してください。
81+
82+
## 貢献
83+
84+
貢献を歓迎します！詳細は[開発ガイド](./docs/development/)を参照してください。
85+
86+
1. リポジトリをフォーク
87+
2. 機能ブランチを作成
88+
3. 変更を加える
89+
4. すべてのテストが通ることを確認
90+
5. プルリクエストを送信
91+
92+
## ライセンス
93+
94+
このプロジェクトは **MIT License** でライセンスされています。
95+
96+
ただし、実行時に自動ダウンロードされる以下のコンポーネントは、それぞれ独自のライセンスの下で配布されています：
97+
- **Blender**: GPL-2.0 License
98+
- **open-fitter-core**: GPL-3.0 License ([Tallcat4's Repository](https://github.com/tallcat4/open-fitter-core))
99+
- **Blenderアドオン**: 各種ライセンス
100+
101+
詳細な情報（コンプライアンス、開発方針、免責事項など）については、[ライセンスドキュメント](./docs/license.md)を参照してください。
102+
103+
## 謝辞
104+
105+
- GPL-3ソースコードコンポーネントを公開してくださったNine Gates
106+
- オープンソースのコアアルゴリズム実装を提供する[open-fitter-core](https://github.com/tallcat4/open-fitter-core)プロジェクトのtallcat4氏
107+
- Blenderソフトウェアを提供するBlender Foundation
108+
- インスピレーションとフィードバックをくださったVRChatコミュニティ
109+
110+
## リンク
111+
112+
- [ドキュメント](./docs/)
113+
- [コアアルゴリズム（ローカル）](./BlenderTools/open-fitter-core/README.md)
114+
- [open-fitter-core (GitHub)](https://github.com/tallcat4/open-fitter-core)
115+
- [Issue Tracker](https://github.com/Mushus/OpenFitterUnityUI/issues)
116+
- [GitHub Discussions](https://github.com/Mushus/OpenFitterUnityUI/discussions)
117+
118+
---
119+
120+
<a name="english"></a>
121+
122+
## Overview
123+
124+
OpenFitterUnityUI is an open-source Unity Editor tool for automatically fitting clothing onto 3D avatar models. It provides a streamlined workflow for VRChat avatar creators and avatar modifiers to transfer clothing between different body shapes.
125+
126+
Built on GPL-3 licensed components from Nine Gates, OpenFitterUnityUI offers a user-friendly Unity Editor interface that automates the complex process of clothing fitting using RBF (Radial Basis Function) deformation and bone pose transfer.
127+
128+
## Features
129+
130+
- **Automated Clothing Fitting**: Transfer clothing from one avatar to another with different body shapes
131+
- **Unity Editor Integration**: Intuitive wizard-based interface directly in Unity
132+
- **Automatic Environment Setup**: Automatically downloads and configures Blender, Python dependencies, and required add-ons
133+
- **BlendShape Management**: Configure and preserve custom blendshapes during the fitting process
134+
- **Progress Tracking**: Real-time progress monitoring during fitting operations
135+
- **Data Format Compatibility**: Compatible with MochiFitter data formats
136+
137+
## Requirements
138+
139+
- Unity 2022.3 or later
140+
- Windows operating system (for Blender automation)
141+
- Internet connection (for initial setup and downloads)
142+
- Approximately 2GB of free disk space (for Blender and dependencies)
143+
144+
## Installation
145+
146+
### Method 1: Unity Package (Recommended)
147+
148+
1. Download the latest `OpenFitterUnityUI.unitypackage` from [GitHub Releases](https://github.com/Mushus/OpenFitterUnityUI/releases)
149+
2. Import the package into your Unity project via `Assets > Import Package > Custom Package`
150+
3. The OpenFitterUnityUI menu will appear under `Tools > OpenFitter`
151+
152+
### Method 2: Manual Installation
153+
154+
1. Clone or download this repository
155+
2. Copy the `Assets/OpenFitter` folder into your Unity project's `Assets` folder
156+
3. Unity will automatically compile the editor scripts
157+
158+
## Quick Start
159+
160+
1. Open the OpenFitter window via `Tools > OpenFitter` in Unity
161+
2. Follow the setup wizard:
162+
- **Environment Setup**: Click "Install All" to automatically set up Blender and dependencies
163+
- **Source Selection**: Select your source avatar (the one with the clothing)
164+
- **Target Selection**: Select your target avatar (the one to receive the clothing)
165+
- **BlendShape Configuration**: (Optional) Configure blendshapes to preserve
166+
- **Execute**: Run the fitting process
167+
3. Wait for the process to complete and review the output
168+
169+
For detailed instructions, see the [Usage Guide](./docs/usage.md).
170+
171+
## Documentation
172+
173+
Detailed documentation is available in the [docs directory](./docs/):
174+
175+
- **For Users**:
176+
- [Setup Guide](./docs/setup.md) - Installation and initial setup
177+
- [Usage](./docs/usage.md) - Basic operation
178+
- [Troubleshooting](./docs/troubleshooting.md) - Common issues and solutions
179+
- [License](./docs/license.md) - License information
180+
181+
- **For Developers**:
182+
- [Development Guide](./docs/development/) - Development environment setup
183+
- [Architecture](./docs/development/architecture.md) - System design
184+
- [Core Technology](./docs/development/technology.md) - Technologies used
185+
- [Project Structure](./docs/development/project-structure.md) - File organization
186+
- [Building](./docs/development/building.md) - Package building
187+
188+
### Running Documentation Site
189+
190+
```bash
191+
npm install
192+
npm run docs:dev
193+
```
194+
195+
Visit [http://localhost:5173](http://localhost:5173) to browse the documentation.
196+
197+
## Contributing
198+
199+
Contributions are welcome! See the [Development Guide](./docs/development/) for details.
200+
201+
1. Fork the repository
202+
2. Create a feature branch
203+
3. Make your changes
204+
4. Ensure all tests pass
205+
5. Submit a pull request
206+
207+
## License
208+
209+
This project is licensed under the **MIT License**.
210+
211+
However, the following components automatically downloaded at runtime are distributed under their own respective licenses:
212+
- **Blender**: GPL-2.0 License
213+
- **open-fitter-core**: GPL-3.0 License ([Tallcat4's Repository](https://github.com/tallcat4/open-fitter-core))
214+
- **Blender Add-ons**: Various licenses
215+
216+
For detailed information (compliance, development policy, disclaimer, etc.), see the [License Documentation](./docs/license.md).
217+
218+
## Acknowledgements
219+
220+
- Nine Gates for releasing the GPL-3 source code components
221+
- tallcat4 for the [open-fitter-core](https://github.com/tallcat4/open-fitter-core) project, providing the open-source core algorithm implementation
222+
- The Blender Foundation for the Blender software
223+
- The VRChat community for inspiration and feedback
224+
225+
## Links
226+
227+
- [Documentation](./docs/)
228+
- [Core Algorithm (Local)](./BlenderTools/open-fitter-core/README.md)
229+
- [open-fitter-core (GitHub)](https://github.com/tallcat4/open-fitter-core)
230+
- [Issue Tracker](https://github.com/Mushus/OpenFitterUnityUI/issues)
231+
- [GitHub Discussions](https://github.com/Mushus/OpenFitterUnityUI/discussions)

‎docs/.vitepress/config.mts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "OpenFitterUnityUI",
6+
description: "Unity向け衣装変換ツール OpenFitterUnityUIの解説ドキュメント",
7+
themeConfig: {
8+
// https://vitepress.dev/reference/default-theme-config
9+
nav: [
10+
{ text: 'Home', link: '/' },
11+
{ text: 'ガイド', link: '/setup' },
12+
{ text: '開発', link: '/development/' }
13+
],
14+
15+
sidebar: [
16+
{
17+
text: '利用者向けガイド',
18+
items: [
19+
{ text: 'セットアップ', link: '/setup' },
20+
{ text: '基本的な使い方', link: '/usage' },
21+
{ text: 'トラブルシューティング', link: '/troubleshooting' },
22+
{ text: 'ライセンス', link: '/license' }
23+
]
24+
},
25+
{
26+
text: '開発者向け',
27+
items: [
28+
{ text: '開発ガイド', link: '/development/' },
29+
{ text: 'アーキテクチャ', link: '/development/architecture' },
30+
{ text: 'コア技術', link: '/development/technology' },
31+
{ text: 'プロジェクト構造', link: '/development/project-structure' },
32+
{ text: 'ビルド方法', link: '/development/building' }
33+
]
34+
}
35+
],
36+
37+
socialLinks: [
38+
{ icon: 'github', link: 'https://github.com/Mushus/OpenFitterUnityUI' }
39+
]
40+
}
41+
})

0 commit comments

Comments
 (0)