Skip to content

Commit

Permalink
Rewrite Getting Started doc, split component list
Browse files Browse the repository at this point in the history
  • Loading branch information
enitimeago committed Sep 10, 2024
1 parent d0a6ea8 commit bb68266
Show file tree
Hide file tree
Showing 7 changed files with 141 additions and 43 deletions.
13 changes: 12 additions & 1 deletion docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ export default defineConfig({
integrations: [
starlight({
title: 'Make It MMD',
favicon: '/favicon.png',
logo: {
replacesTitle: true,
src: './src/assets/logo.png',
},
customCss: [
'./src/styles/custom.scss',
'@fontsource-variable/public-sans/wght.css',
Expand All @@ -33,18 +38,24 @@ export default defineConfig({
sidebar: [
{
label: 'Guides',
translations: {
'ja': 'ガイド',
},
items: [
{
label: 'Getting Started',
slug: 'guides/getting-started',
translations: {
'ja': 'セットアップガイド',
'ja': 'はじめに',
},
},
],
},
{
label: 'Reference',
translations: {
'ja': 'ドキュメント',
},
autogenerate: { directory: 'reference' },
},
],
Expand Down
57 changes: 57 additions & 0 deletions docs/src/content/docs/en/guides/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Getting Started
description: How to get started with Make It MMD for VRChat avatars
---

import { Aside, Tabs, TabItem, Steps, LinkButton } from '@astrojs/starlight/components';

Make It MMD helps set up your VRChat avatars for MMD worlds, based on their existing facial expressions.

- 🌟 It's **non-destructive**. It runs only when you build your avatar, so its original data is never modified.
- ✏️ Settings are **editable any time**. We never bake your settings into your avatar's mesh, so you don't have to start again from scratch.
- 🤖 Scans and auto-fixes for **common issues**. We take care of Write Default and face mesh renaming for you. Of course, your animator controllers are handled non-destructively.
- 💌 Plus **import and export** tools. If you've used a destructive tool before, you can bring in your existing data (only 1:1 blend shape copies supported). And export only shares the expressions chosen, no need to worry about sharing your avatar's mesh data.

## Installation

<Tabs>

<TabItem label="VCC">

Installation via VRChat Creator Companion is recommended.

<Steps>

1. Click the below link to add our repository to your VRChat Creator Companion.

<LinkButton href="vcc://vpm/addRepo?url=https://enitimeago.github.io/vpm-repos/index.json">Add to VCC</LinkButton>

You'll need to select "I Understand, Add Repository" for it to complete.

2. Next, navigate to the project you wish to install to.

3. In the packages list, click the `+` on the far-right side where "Make It MMD" is listed.

</Steps>

</TabItem>

<TabItem label="Other">

Alternatively, .unitypackage files can be downloaded from the official GitHub repository.

<Aside type="caution" title="Caution">Updating requires manually downloading the latest release every time, so this is not recommended.</Aside>

<Steps>

1. Download the newest .unitypackage from the official GitHub repository's [Releases](https://github.com/enitimeago/make-it-mmd/releases) page.

2. In Unity, open the project you'd like to install to.

3. Open the downloaded .unitypackage, or drag & drop it to the Unity window to install.

</Steps>

</TabItem>

</Tabs>
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
---
title: Getting Started
description: How to get started with Make It MMD for VRChat avatars
title: Component Reference
---

Make It MMD helps set up your VRChat avatars for MMD worlds, based on their existing facial expressions.

- 🌟 It's **non-destructive**. It runs only when you build your avatar, so its original data is never modified.
- ✏️ Settings are **editable any time**. We never bake your settings into your avatar's mesh, so you don't have to start again from scratch.
- 🤖 Scans and auto-fixes for **common issues**. We take care of Write Default and face mesh renaming for you. Of course, your animator controllers are handled non-destructively.
- 💌 Plus **import and export** tools. If you've used a destructive tool before, you can bring in your existing data (only 1:1 blend shape copies supported). And export only shares the expressions chosen, no need to worry about sharing your avatar's mesh data.

In order to support facial animations in popular VRChat MMD worlds, your avatar must meet the following conditions:

1. Your avatar's face mesh must have blend shapes named the same as MMD morphs.
Expand Down
11 changes: 0 additions & 11 deletions docs/src/content/docs/en/reference/example.md

This file was deleted.

70 changes: 70 additions & 0 deletions docs/src/content/docs/ja/guides/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: はじめに
description: VRChatアバター用ツールMake It MMDのセットアップガイド
---

import { Aside, Tabs, TabItem, Steps, LinkButton } from '@astrojs/starlight/components';

Make It MMDは、VRChatアバターの既存の表情からMMDシェイプキーを**生成すること**を始め、さまざまな**自動修正**を提供するMMDワールドに対応させるツールです。

- 🌟 **安全な適応**:アバターの元のデータ(メッシュ、アニメーションコントローラーなど)を上書きせずに処理を行います。
- ✏️ **簡単な表情変更**:表情設定エディターでいつでも選択した表情を変更できます。
- 🤖 **一般問題のスキャンと自動修正**:Write Defaultやフェイスメッシュの名前変更を自動で処理します。アニメーターコントローラーも非破壊的に処理されます。
- 💌 **インポートとエクスポート機能**:以前に破壊的なツールを使用した場合でも、既存のMMDシェイプキーが元のアバターのシェイプキーと同等している場合は取り込むことができます。エクスポートでは選択された表情のみが共有され、アバターのメッシュデータを共有する恐れがありません。

## インストールの方法

いくつかのインストールの方法があります。以下の種類からどちらでも可能です。

<Tabs>

<TabItem label="VCC">

VRChat Creator Companionでインストールすると、最新バージョンが自動にインストールします。

<Steps>

1. 下のボタンをクリックしてVRChat Creator Companionのリポジトリ登録の画面が開きます。

<LinkButton href="vcc://vpm/addRepo?url=https://enitimeago.github.io/vpm-repos/index.json">VCCに追加</LinkButton>

画面の「I Understand, Add Repository」をクリックすると、登録が完了します。

2. リポジトリ登録後、導入先のプロジェクトの管理画面を開きます。

3. パッケージ一覧に「Make It MMD」の右端の`+`ボタンをクリックしてインストールが完了します。

</Steps>

</TabItem>

<TabItem label="BOOTH">

BOOTHで配布している.unitypackageは、自動に最新バージョンをダウンロードとインストールを行います。
したがって、この.unitypackageを使う場合はインターネット回線が必要です。

1. 下のボタンをクリックしてBOOTHのページからダウンロードできます。

<LinkButton href="https://eni.booth.pm/items/5530958">BOOTHで無料ダウンロード</LinkButton>

2. Unityで導入したいプロジェクトを開きます。

3. ダウンロードした.zipファイルを展開し、入っている.unitypackageを開き、または.unitypackageをUnityのウィンドウにドラッグ&ドロップすることでインポートできます。

</TabItem>

<TabItem label="その他">

オフラインでも使える.unitypackageが公式GitHubで配布しています。

<Aside type="caution" title="注意">アップデートたびにダReleasesページから再ダウンロードする必要があるため非推奨です。</Aside>

1. 公式GitHubリポジトリの[Releases](https://github.com/enitimeago/make-it-mmd/releases)ページで最新の.unitypackageをダウンロードできます。

2. Unityで導入したいプロジェクトを開きます。

3. .unitypackageを開き、または.unitypackageをUnityのウィンドウにドラッグ&ドロップすることでインポートできます。

</TabItem>

</Tabs>
Original file line number Diff line number Diff line change
@@ -1,17 +1,7 @@
---
title: セットアップガイド
description: VRChatアバター用ツールMake It MMDのセットアップガイド
title: コンポーネント一覧
---

Make It MMDは、VRChatアバターの既存の表情を基づいて、MMDブレンドシェープを**作成すること**および**設定を共有すること**を容易にします。初期設定だけでなく、適応後に表情設定も変更可能です!

- 🌟 本ツールは**非破壊的**で、アバターをビルドする際にのみ実行されます。
- ✏️ 設定は**いつでも編集可能**です。設定はアバターのメッシュに焼き込まれないため、最初からやり直す必要はありません。
- 🤖 一般的な問題の**スキャンと自動修正**ができます。Write Defaultやフェイスメッシュの名前変更を自動で処理します。もちろん、アニメーターコントローラーも非破壊的に処理されます!
- 💌 **インポートとエクスポート機能**も用意しています。以前に破壊的なツールを使用した場合でも、既存のデータを取り込むことができます※。エクスポートでは選択された表情のみが共有され、アバターのメッシュデータを共有する恐れがありません。

※インポート機能は現在、アバターの既存ブレンドシェープを正確なコピーのみをインポートできますので、予めご了承ください。

## 新しいMMD用ブレンドシェイプを追加

- ヒエラルキーにアバターを右クリック
Expand Down
11 changes: 0 additions & 11 deletions docs/src/content/docs/ja/reference/example.md

This file was deleted.

0 comments on commit bb68266

Please sign in to comment.