Skip to content

Commit

Permalink
Merge pull request #1163 from anatawa12/add-non-destructive-to-basic-…
Browse files Browse the repository at this point in the history
…consept

docs: mention non-destructive in basic-concept
  • Loading branch information
anatawa12 authored Aug 27, 2024
2 parents f4dc1fc + e62a490 commit ee8133b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
11 changes: 8 additions & 3 deletions .docs/content/docs/basic-concept/index.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,19 @@ title: "基本コンセプト"

## Avatar Optimizerとは? {#what-is-avatar-optimizer}

Avatar Optimizerは、アバターを最適化するためのツールです
Avatar Optimizerは、アバターを非破壊的に最適化するためのツールです
このツールはVRChatアバター向けに設計されていましたが、[NDMF]でサポートされている他のプラットフォームのアバターにも使用できるかもしれません。

VRChat以外のプラットフォームのアバターに対するサポートは完全にコミュニティベースであり、Avatar Optimizerの開発チームにはサポートされない場合があります。
(Avatar Optimizerにおいて、)「非破壊的」とは以下のことを指します。
- Avatar Optimizerを使用するためにプレハブを展開(unpack)する必要がないこと。
- Avatar Optimizerを使用するために必要なことは、コンポーネントを追加することだけです。
- Avatar Optimizerはプロジェクトに保存されているアバターに一切影響を与えず、ビルド中に生成されるアバターデータの一時コピーにのみ影響すること。

なお、VRChat以外のプラットフォームのアバターに対するサポートは主にコミュニティベースであり、Avatar Optimizerの開発チームにはサポートされない場合があります。

## Avatar Optimizerの目的は何ですか? {#what-is-the-goal-of-avatar-optimizer}

このツールは、アバターの見た目を殆ど変化させることなく、簡単にアバターのパフォーマンスを最適化できるようにすることを目的として設計されています
このツールは、アバターの見た目を殆ど変化させることなく、アバターのパフォーマンスを非破壊的に最適化できるようにすることを目的として設計されています
そのため、このツールでアバターの振る舞いを変更することは意図していません。

意図していない動作によるアバターの振る舞いの変更は、一部のユースケースで有用かもしれませんが、バグとして扱われます。\
Expand Down
14 changes: 10 additions & 4 deletions .docs/content/docs/basic-concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,21 @@ This page describes the basic concepts of Avatar Optimizer.

## What is Avatar Optimizer? {#what-is-avatar-optimizer}

Avatar Optimizer is a tool that helps you optimize your avatar.
Avatar Optimizer is a non-destructive tool that helps you optimize your avatar.
This tool is initially designed for VRChat avatars, but it might be usable for other Avatars supported by [NDMF].

Non-VRChat avatar support is completely community-based and may not be supported by the Avatar Optimizer dev team.
Non-destructive means (in Avatar Optimizer):
- You don't have to unpack your prefab to apply Avatar Optimizer.
- What you have to do is adding component.
- Avatar Optimizer doesn't affects avatar saved in your project, only affects temporal copy of avatar for building.

Please note that non-VRChat avatar support is generally community-based and may not be supported by the Avatar Optimizer dev team.


## What is the goal of Avatar Optimizer? {#what-is-the-goal-of-avatar-optimizer}

This tool is designed to help you optimize your avatar in performance without affecting the appearance so much.\
Therefore, it is not intended to make changes of the avatar behavior.
The main goal of this tool is to help you optimize your avatar in performance without affecting the appearance so much, in non-destructive way.\
This tool is not designed to make changes of the avatar behavior.

All non-configured changes in the avatar behavior is treated as a bug, even if it might be useful in some use cases.\
In some cases, we may put off the bug since it does not affect so much for most use cases.\
Expand Down

0 comments on commit ee8133b

Please sign in to comment.