From 13a5bb5d5094a8cf0efb6368824bf9145effcb84 Mon Sep 17 00:00:00 2001 From: bd_ Date: Sat, 22 Oct 2022 12:42:02 -0700 Subject: [PATCH] Adding logo to docs page --- .github/workflows/build-test-docs.yml | 7 + COPYING.md | 10 + docs/docs/samples/index.md | 2 +- .../current/intro.md | 89 ++------- docs/src/pages/index.module.css | 9 +- docs/src/pages/index.tsx | 11 +- docs/static/img/logo.svg | 1 - docs/static/img/logo/.gitignore | 2 + docs/static/img/logo/README.md | 5 + docs/static/img/logo/logo_fallback.png | Bin 0 -> 5142 bytes .../static/img/undraw_docusaurus_mountain.svg | 171 ------------------ docs/static/img/undraw_docusaurus_react.svg | 170 ----------------- docs/static/img/undraw_docusaurus_tree.svg | 40 ---- 13 files changed, 57 insertions(+), 460 deletions(-) delete mode 100644 docs/static/img/logo.svg create mode 100644 docs/static/img/logo/.gitignore create mode 100644 docs/static/img/logo/README.md create mode 100644 docs/static/img/logo/logo_fallback.png delete mode 100644 docs/static/img/undraw_docusaurus_mountain.svg delete mode 100644 docs/static/img/undraw_docusaurus_react.svg delete mode 100644 docs/static/img/undraw_docusaurus_tree.svg diff --git a/.github/workflows/build-test-docs.yml b/.github/workflows/build-test-docs.yml index 9ce600e6..e7c79005 100644 --- a/.github/workflows/build-test-docs.yml +++ b/.github/workflows/build-test-docs.yml @@ -13,6 +13,13 @@ jobs: with: node-version: 18 - uses: actions/checkout@v3 # check out this repo + - uses: actions/checkout@v3 + with: + repository: bdunderscore/modular-avatar-images + path: modular-avatar-images + - name: Install logo assets + run: | + cp -Rv modular-avatar-images/img/* docs/static/img - name: Build docs run: | diff --git a/COPYING.md b/COPYING.md index 9f309c9c..f571af12 100644 --- a/COPYING.md +++ b/COPYING.md @@ -1,3 +1,13 @@ +Source code is licensed under the MIT license, as reproduced below, with some exceptions: + +* Packages/com.vrchat.core.vpm-resolver is distributed under the VRChat Distro license. + See [the associated License.md file](Packages/com.vrchat.core.vpm-resolver/License.md) for details. +* Images under docs/static/img/irasutoya are Copyrighted by, and/or a derivative work of works copyrighted by + いらすとや (irasutoya.com). See [their license page](https://www.irasutoya.com/p/terms.html) for license details. +* Images under docs/static/img/logo are Copyright (c) 2022 Pumo. See the associated COPYING file for details. + +--- + MIT License Copyright (c) 2022 bd_ diff --git a/docs/docs/samples/index.md b/docs/docs/samples/index.md index 2a094407..9f6c6963 100644 --- a/docs/docs/samples/index.md +++ b/docs/docs/samples/index.md @@ -19,7 +19,7 @@ The fingerpen prefab demonstrates: * Installing animators using [Merge Animator](../reference/merge-animator.md) * Automatically configuring [synced parameters](../reference/parameters.md) * Setting up [menus](../reference/menu-installer.md). -* Using the [Bone Proxy](bone-proxy.md) component to place objects inside of the avatar's bones, in an avatar-agnostic way +* Using the [Bone Proxy](../reference/bone-proxy.md) component to place objects inside of the avatar's bones, in an avatar-agnostic way ## Clap diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md index 8423bb97..d2eb39f5 100644 --- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md @@ -2,89 +2,28 @@ sidebar_position: 1 --- -# モデュラーアバター +# Modular Avatar -モデュラーアバターは、アバター設定を分割したり、アバター用ギミックや衣装を配布するための**非破壊的な**ツールキットです。 -モデュラーアバターを使えば、新しい衣装やギミックの導入はドラッグアンドドロップで楽ちんです！ +Modular Avatar is a suite of **non-destructive** tools for modularizing your avatars, and for distributing avatar +components. +With Modular Avatar, adding a new outfit or gimmick to your avatar is as easy as drag-and-drop! -モデュラーアバターは現在以下の機能があります。 - -* 衣装導入でよくやる、プレハブのアーマチュアを親のアバターに統合すること。この過程で新規生成されるボーンを最小限にして、できる限り既存のボーンを使いまわします。 -* 部分的なアニメーターを親に統合することで、様々のギミックの実装を簡単にします。 +Modular Avatar's features are packaged as individual components, which can be added as needed. You can opt-in to just the features +you want to use. It can automatically merge outfits onto your avatar, build an animator out of multiple components, and much more. :::caution -モデュラーアバターは現在まだ開発中で、本番環境での使用は推奨しません。バージョン1.0に向けて、後方互換性のない変更が行われる可能性があります。 -そのため、モデュラーアバターをベースにしたプレハブを配布することは、バージョン1.0がリリースされるまでお勧めしません。 +Modular Avatar is still in development, and is not yet ready for production use. Backwards-incompatible changes may +be made prior to version 1.0. As such, it is not recommended to distribute prefabs based on Modular Avatar until the +1.0 release. ::: -## 衣装等の統合 +To install Modular Avatar, download and import the `unitypackage` file from the "Assets" section on [the latest release](https://github.com/bdunderscore/modular-avatar/releases). -![img_1.png](img_1.png) +Then, check out one of the tutorials below: +* [Simple clothing setup](tutorials/clothing) -衣装のアーマチュアに`Modular Avatar Merge Armature`を着けることで、ビルドやプレイ時に自動的に親のアバターに統合します。結果は以下のようになります。 +You can also check out some of the [detailed reference documentation](reference) on individual components. -![img_3.png](img_3.png) - -衣装で追加される新規ボーンのみが追加されているのがお判りでしょう。 - -`Merge Armature`のスクリプトは、自動的に`Merge Target`下に、自分についているボーンとその子に該当するボーンを探し当てます。 -自分がついている方のボーンは、`Prefix`で始まり、`Suffix`で終わると仮定し、その補正も行います。該当するオブジェクトが見つからない場合、 -アバターに新規オブジェクトとして追加します（スカートやリボン等のボーンには便利です） - -衣装のON/OFFは親プレハブのON/OFFだけで済みます。そのために、PhysBonesなどのコンポーネントは統合先に移動せずに、 -元の位置から統合したボーンと連動するように設定されます。PhysBonesやContactの場合は、`Root Transform`が統合先の該当アーマチュアボーンに設定されます。 -そのほかのコンポーネントの場合は、必要に応じて`Parent Constrant`が生成されます。 - -統合の過程で、本来のアバターのアーマチュアに当てれるよう、Skinned Meshの処理（BindPose再計算）が行われます。異なる3Dソフトで作られたアバターと衣装は -これによって無事に統合できるようになります。 - -微調整が必要の場合は、統合前のアーマチュアを調整することができます。`Locked`のオプションを外せば、ワールド位置が保持されます -（親アバターの該当ボーンの中にボーンが配置されるような挙動になります） - -## 複雑なギミックの統合 - -アニメーターを含んだギミックのためには、`Merge Animator`コンポーネントもあります。 - -![img_4.png](img_4.png) - -このコンポーネントを着けることで、指定したアニメーターコントローラーが該当するplayable layerに統合されます。 -また、`Delete Attached Animator`が有効の場合、同じゲームオブジェクトに付けられたアニメーターが削除されます。 -（残しておくとアニメーション編集が楽なので） - -編集しやすくするため、統合されるアニメーターのアニメションは統合前の位置でアニメーションクリップを作ってください。 -つまり、`Merge Animator`スクリプトまでのパスを指定する必要はなく、その子のパスだけで済みます。 - -![img_5.png](img_5.png) - -Unityの「録画モード」で、同じゲームオブジェクトに付けられるアニメーターでアニメーションクリップを作れば、自動的にいい感じになるはずです。 - -### アバターのどこかにオブジェクトを配置 - -コンタクトなど、ヒエラルキーの別の位置にオブジェクトを配置する必要がある場合があります。`Merge Armature`を使ってもいいですが、ボーン名や位置など -を合わせる必要があって、どのアバターでも適用できるギミックには最適解ではありません。 - -そのかわりに`Modular Avatar Proxy Bone`を使いましょう。このコンポーネントを付けることで、該当Transformが指定したボーンの位置や姿勢に連動するようになります。 - -![img_6.png](img_6.png) - -追尾したいトランスフォームを`Target`にドラッグアンドドロップをすれば、後は自動的に設定されます。 - -ビルド時に、このProxy Boneのオブジェクトが実際のボーンの下に配備され、アニメーション参照がそれに応じて調整されます。 - -### ヒューマノイドボーンのアニメーション - -通常のヒューマノイドアニメーションは特に特別な設定をしなくても統合アニメーターで使えます。 - -### 非ヒューマノイドボーンのアニメーション - -ケモミミなど非ヒューマノイドボーンをアニメーションするときは、少し特別な設定が必要です。 -Lockedが有効の状態の`Modular Avatar Merge Armature`コンポーネントを使いましょう。 - -![img_7.png](img_7.png) - -Lockedが有効だと、元のボーンと統合ボーンが連動して動きます。つまりはアニメーションを作るときは統合前のプロクシーボーンを動かせば、 -該当するアバターボーンも動くからやっていることが分かりやすいです。 - -ビルド時はこのプロクシーボーンが親アバターに統合されるので、パフォーマンスランクに関与しません。 \ No newline at end of file +Finally, if you are developing your own prefabs using Modular Avatar, check out the [page on prefab distribution](distributing-prefabs). \ No newline at end of file diff --git a/docs/src/pages/index.module.css b/docs/src/pages/index.module.css index 385182a3..d8040e39 100644 --- a/docs/src/pages/index.module.css +++ b/docs/src/pages/index.module.css @@ -4,7 +4,7 @@ */ .heroBanner { - padding: 4rem 0; + padding: 1.8rem 0 4rem; text-align: center; position: relative; overflow: hidden; @@ -26,3 +26,10 @@ margin-right: 1rem; margin-left: 1rem; } + +div.logo { + height: 100px; + text-align: center; + display: flex; + justify-content: center; +} \ No newline at end of file diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 67dceaf1..2e9b9174 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -7,13 +7,22 @@ import HomepageFeatures from '@site/src/components/HomepageFeatures'; import styles from './index.module.css'; import Translate, {translate} from '@docusaurus/Translate'; +let logo; +try { + logo = require('@site/static/img/logo/ma_logo.png'); +} catch (ex) { + logo = require('@site/static/img/logo/logo_fallback.png'); +} + function HomepageHeader() { const {siteConfig} = useDocusaurusContext(); return (

- Modular Avatar +
+ Modular Avatar +

Drag-and-Drop Avatar Assembly diff --git a/docs/static/img/logo.svg b/docs/static/img/logo.svg deleted file mode 100644 index 9db6d0d0..00000000 --- a/docs/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/static/img/logo/.gitignore b/docs/static/img/logo/.gitignore new file mode 100644 index 00000000..cfc519b2 --- /dev/null +++ b/docs/static/img/logo/.gitignore @@ -0,0 +1,2 @@ +# Real logo assets +ma_* \ No newline at end of file diff --git a/docs/static/img/logo/README.md b/docs/static/img/logo/README.md new file mode 100644 index 00000000..1b32648d --- /dev/null +++ b/docs/static/img/logo/README.md @@ -0,0 +1,5 @@ +logo_fallback.png is from the Docusaurus sample assets. + +The modular avatar logo is licensed for use only as part of official distributions of Modular Avatar and its documentation. +We merge it in as part of the github build workflows; for regular docs development, a placeholder is used instead. +For more information, please see the [image assets repository](https://github.com/bdunderscore/modular-avatar-images). \ No newline at end of file diff --git a/docs/static/img/logo/logo_fallback.png b/docs/static/img/logo/logo_fallback.png new file mode 100644 index 0000000000000000000000000000000000000000..f458149e3c8f53335f28fbc162ae67f55575c881 GIT binary patch literal 5142 zcma)=cTf{R(}xj7f`AaDml%oxrAm_`5IRVc-jPtHML-0kDIiip57LWD@4bW~(nB|) z34|^sbOZqj<;8ct`Tl-)=Jw`pZtiw=e$UR_Mn2b8rM$y@hlq%XQe90+?|Mf68-Ux_ zzTBiDn~3P%oVt>{f$z+YC7A)8ak`PktoIXDkpXod+*gQW4fxTWh!EyR9`L|fi4YlH z{IyM;2-~t3s~J-KF~r-Z)FWquQCfG*TQy6w*9#k2zUWV-+tCNvjrtl9(o}V>-)N!) ziZgEgV>EG+b(j@ex!dx5@@nGZim*UfFe<+e;(xL|j-Pxg(PCsTL~f^br)4{n5?OU@ z*pjt{4tG{qBcDSa3;yKlopENd6Yth=+h9)*lkjQ0NwgOOP+5Xf?SEh$x6@l@ZoHoYGc5~d2>pO43s3R|*yZw9yX^kEyUV2Zw1%J4o`X!BX>CwJ zI8rh1-NLH^x1LnaPGki_t#4PEz$ad+hO^$MZ2 ziwt&AR}7_yq-9Pfn}k3`k~dKCbOsHjvWjnLsP1{)rzE8ERxayy?~{Qz zHneZ2gWT3P|H)fmp>vA78a{0&2kk3H1j|n59y{z@$?jmk9yptqCO%* zD2!3GHNEgPX=&Ibw?oU1>RSxw3;hhbOV77-BiL%qQb1(4J|k=Y{dani#g>=Mr?Uyd z)1v~ZXO_LT-*RcG%;i|Wy)MvnBrshlQoPxoO*82pKnFSGNKWrb?$S$4x+24tUdpb= zr$c3K25wQNUku5VG@A=`$K7%?N*K+NUJ(%%)m0Vhwis*iokN#atyu(BbK?+J+=H z!kaHkFGk+qz`uVgAc600d#i}WSs|mtlkuwPvFp) z1{Z%nt|NwDEKj1(dhQ}GRvIj4W?ipD76jZI!PGjd&~AXwLK*98QMwN&+dQN1ML(6< z@+{1`=aIc z9Buqm97vy3RML|NsM@A>Nw2=sY_3Ckk|s;tdn>rf-@Ke1m!%F(9(3>V%L?w#O&>yn z(*VIm;%bgezYB;xRq4?rY})aTRm>+RL&*%2-B%m; zLtxLTBS=G!bC$q;FQ|K3{nrj1fUp`43Qs&V!b%rTVfxlDGsIt3}n4p;1%Llj5ePpI^R} zl$Jhx@E}aetLO!;q+JH@hmelqg-f}8U=XnQ+~$9RHGUDOoR*fR{io*)KtYig%OR|08ygwX%UqtW81b@z0*`csGluzh_lBP=ls#1bwW4^BTl)hd|IIfa zhg|*M%$yt@AP{JD8y!7kCtTmu{`YWw7T1}Xlr;YJTU1mOdaAMD172T8Mw#UaJa1>V zQ6CD0wy9NEwUsor-+y)yc|Vv|H^WENyoa^fWWX zwJz@xTHtfdhF5>*T70(VFGX#8DU<^Z4Gez7vn&4E<1=rdNb_pj@0?Qz?}k;I6qz@| zYdWfcA4tmI@bL5JcXuoOWp?ROVe*&o-T!><4Ie9@ypDc!^X&41u(dFc$K$;Tv$c*o zT1#8mGWI8xj|Hq+)#h5JToW#jXJ73cpG-UE^tsRf4gKw>&%Z9A>q8eFGC zG@Iv(?40^HFuC_-%@u`HLx@*ReU5KC9NZ)bkS|ZWVy|_{BOnlK)(Gc+eYiFpMX>!# zG08xle)tntYZ9b!J8|4H&jaV3oO(-iFqB=d}hGKk0 z%j)johTZhTBE|B-xdinS&8MD=XE2ktMUX8z#eaqyU?jL~PXEKv!^) zeJ~h#R{@O93#A4KC`8@k8N$T3H8EV^E2 z+FWxb6opZnX-av5ojt@`l3TvSZtYLQqjps{v;ig5fDo^}{VP=L0|uiRB@4ww$Eh!CC;75L%7|4}xN+E)3K&^qwJizphcnn=#f<&Np$`Ny%S)1*YJ`#@b_n4q zi%3iZw8(I)Dzp0yY}&?<-`CzYM5Rp+@AZg?cn00DGhf=4|dBF8BO~2`M_My>pGtJwNt4OuQm+dkEVP4 z_f*)ZaG6@t4-!}fViGNd%E|2%ylnzr#x@C!CrZSitkHQ}?_;BKAIk|uW4Zv?_npjk z*f)ztC$Cj6O<_{K=dPwO)Z{I=o9z*lp?~wmeTTP^DMP*=<-CS z2FjPA5KC!wh2A)UzD-^v95}^^tT<4DG17#wa^C^Q`@f@=jLL_c3y8@>vXDJd6~KP( zurtqU1^(rnc=f5s($#IxlkpnU=ATr0jW`)TBlF5$sEwHLR_5VPTGiO?rSW9*ND`bYN*OX&?=>!@61{Z4)@E;VI9 zvz%NmR*tl>p-`xSPx$}4YcdRc{_9k)>4Jh&*TSISYu+Y!so!0JaFENVY3l1n*Fe3_ zRyPJ(CaQ-cNP^!3u-X6j&W5|vC1KU!-*8qCcT_rQN^&yqJ{C(T*`(!A=))=n%*-zp_ewRvYQoJBS7b~ zQlpFPqZXKCXUY3RT{%UFB`I-nJcW0M>1^*+v)AxD13~5#kfSkpWys^#*hu)tcd|VW zEbVTi`dbaM&U485c)8QG#2I#E#h)4Dz8zy8CLaq^W#kXdo0LH=ALhK{m_8N@Bj=Um zTmQOO*ID(;Xm}0kk`5nCInvbW9rs0pEw>zlO`ZzIGkB7e1Afs9<0Z(uS2g*BUMhp> z?XdMh^k}k<72>}p`Gxal3y7-QX&L{&Gf6-TKsE35Pv%1 z;bJcxPO+A9rPGsUs=rX(9^vydg2q`rU~otOJ37zb{Z{|)bAS!v3PQ5?l$+LkpGNJq zzXDLcS$vMy|9sIidXq$NE6A-^v@)Gs_x_3wYxF%y*_e{B6FvN-enGst&nq0z8Hl0< z*p6ZXC*su`M{y|Fv(Vih_F|83=)A6ay-v_&ph1Fqqcro{oeu99Y0*FVvRFmbFa@gs zJ*g%Gik{Sb+_zNNf?Qy7PTf@S*dTGt#O%a9WN1KVNj`q$1Qoiwd|y&_v?}bR#>fdP zSlMy2#KzRq4%?ywXh1w;U&=gKH%L~*m-l%D4Cl?*riF2~r*}ic9_{JYMAwcczTE`!Z z^KfriRf|_YcQ4b8NKi?9N7<4;PvvQQ}*4YxemKK3U-7i}ap8{T7=7`e>PN7BG-Ej;Uti2$o=4T#VPb zm1kISgGzj*b?Q^MSiLxj26ypcLY#RmTPp+1>9zDth7O?w9)onA%xqpXoKA-`Jh8cZ zGE(7763S3qHTKNOtXAUA$H;uhGv75UuBkyyD;eZxzIn6;Ye7JpRQ{-6>)ioiXj4Mr zUzfB1KxvI{ZsNj&UA`+|)~n}96q%_xKV~rs?k=#*r*7%Xs^Hm*0~x>VhuOJh<2tcb zKbO9e-w3zbekha5!N@JhQm7;_X+J!|P?WhssrMv5fnQh$v*986uWGGtS}^szWaJ*W z6fLVt?OpPMD+-_(3x8Ra^sX~PT1t5S6bfk@Jb~f-V)jHRul#Hqu;0(+ER7Z(Z4MTR z+iG>bu+BW2SNh|RAGR2-mN5D1sTcb-rLTha*@1@>P~u;|#2N{^AC1hxMQ|(sp3gTa zDO-E8Yn@S7u=a?iZ!&&Qf2KKKk7IT`HjO`U*j1~Df9Uxz$~@otSCK;)lbLSmBuIj% zPl&YEoRwsk$8~Az>>djrdtp`PX z`Pu#IITS7lw07vx>YE<4pQ!&Z^7L?{Uox`CJnGjYLh1XN^tt#zY*0}tA*a=V)rf=&-kLgD|;t1D|ORVY}8 F{0H{b<4^zq literal 0 HcmV?d00001 diff --git a/docs/static/img/undraw_docusaurus_mountain.svg b/docs/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c49..00000000 --- a/docs/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/static/img/undraw_docusaurus_react.svg b/docs/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf08..00000000 --- a/docs/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/static/img/undraw_docusaurus_tree.svg b/docs/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d33..00000000 --- a/docs/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -