diff --git a/README.md b/README.md index d243cbfe..0595a0f2 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,6 @@ Modular Avatar currently supports: that are created in this process, reusing existing bones where possible. * Merging subcomponent animators into the parent avatar, for use with various types of avatar gimmicks. -**Warning**: 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. - For more information, check out the [documentation](https://m-a.nadena.dev). --- @@ -28,7 +24,4 @@ For more information, check out the [documentation](https://m-a.nadena.dev). * 衣装導入でよくやる、プレハブのアーマチュアを親のアバターに統合すること。この過程で新規生成されるボーンを最小限にして、できる限り既存のボーンを使いまわします。 * 部分的なアニメーターを親に統合することで、様々のギミックの実装を簡単にします。 -**注意:** モジュラーアバターは現在まだ開発中で、本番環境での使用は推奨しません。バージョン1.0に向けて、後方互換性のない変更が行われる可能性があります。 -そのため、モジュラーアバターをベースにしたプレハブを配布することは、バージョン1.0がリリースされるまでお勧めしません。 - 詳しくは[ドキュメンテーションページにご参照ください](https://modular-avatar.nadena.dev/ja/). diff --git a/docs/docs/distributing-prefabs/index.md b/docs/docs/distributing-prefabs/index.md index ecd2367c..5ca801f7 100644 --- a/docs/docs/distributing-prefabs/index.md +++ b/docs/docs/distributing-prefabs/index.md @@ -36,4 +36,4 @@ An easy way of applying such settings is using the prefab overrides menu - you c ## Use internal parameters on your animator gimmicks -Using [internal parameters](../reference/parameters.md) can help avoid clashing with other prefabs. Internal parameters are automatically renamed to a unique name at build time, ensuring you won't have any name clashes. +Using [internal parameters](../reference/parameters.md) can help avoid clashing with other prefabs. Internal parameters are automatically renamed to a unique name at build time, ensuring you won't have any name clashes. \ No newline at end of file diff --git a/docs/docs/distributing-prefabs/versioning-policy.md b/docs/docs/distributing-prefabs/versioning-policy.md new file mode 100644 index 00000000..edaed1fb --- /dev/null +++ b/docs/docs/distributing-prefabs/versioning-policy.md @@ -0,0 +1,9 @@ +# Versioning policy + +Modular Avatar subscribes to [Semantic Versioning](https://semver.org/). This means that: + +* When incompatible changes are made, the first component of the version number will change (e.g. 1.0.0 -> 2.0.0). +* When new features are added in a backwards compatible way, the second component of the version number will change (e.g. 1.0.0 -> 1.1.0). Prefabs made with e.g. 1.1.0 may not work on 1.0.0, but prefabs made with 1.0.0 will work with 1.1.0. +* When minor bugfixes and other changes that don't affect save format are made, the third component will change (1.0.0 -> 1.0.1). Unless the bug fix affects your prefab, generally using an older patch version should not be a large issue. + +In general, using the latest version of modular avatar under the same major version (1.x.x) is recommended. \ No newline at end of file diff --git a/docs/docs/intro.md b/docs/docs/intro.md index d2eb39f5..0a8861f0 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -11,14 +11,6 @@ With Modular Avatar, adding a new outfit or gimmick to your avatar is as easy as 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 - -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). Then, check out one of the tutorials below: diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/distributing-prefabs/versioning-policy.md b/docs/i18n/ja/docusaurus-plugin-content-docs/current/distributing-prefabs/versioning-policy.md new file mode 100644 index 00000000..3d1caa1d --- /dev/null +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/distributing-prefabs/versioning-policy.md @@ -0,0 +1,9 @@ +# バージョンポリシー + +モジュラーアバターは[Semantic Versioning](https://semver.org/lang/ja/)を採用しています。これがどういうことかというと、 + +* 互換性のない変更が入った場合は、バージョン番号の最初の数字が変わります (例: 1.0.0 -> 2.0.0)。 +* 互換性のある新機能が追加された場合は、バージョン番号の2番目の数字が変わります (例: 1.0.0 -> 1.1.0)。例えば1.1.0で作られたアセットは1.0.0では動作しないかもしれませんが、1.0.0で作られたアセットは1.1.0で動作します。 +* バグ修正やセーブフォーマットに影響のない変更が入った場合は、バージョン番号の3番目の数字が変わります (1.0.0 -> 1.0.1)。バグ修正がアセットに影響を与えない限り、古いパッチバージョンを使うことは問題にはならないでしょう。 + +原則として、同じメジャーバージョン（1.x.xなど）の中で最新版を使うことをお勧めします。 \ No newline at end of file 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 0c2ddc5a..0cf2a1c3 100644 --- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md @@ -9,13 +9,6 @@ Modular Avatarを使えば、ドラッグアンドドロップだけでアバタ Modular Avatarの機能はそれぞれコンポーネントとして提供され、必要に応じて必要な機能だけ追加できます。自動的に衣装を統合したり、複数のアセットからアニメーターを構築したり、様々な面で製作を補助します。 -:::caution - -Modular Avatarは開発途中であり、まだ本格運用が非推奨です。1.0までは互換性が補助されない変更が入る可能性があります。Modular Avatarを応用したプレハブの配布は -1.0まで待つことをお勧めします。 - -::: - Modular Avatarをインストールするには、[最新リリース]のAssets項目から`unitypackage`ファイルをダウンロードして、インポートしてください。 その後の手順に関しては以下のチュートリアルを見てください