mirror of
https://github.com/bdunderscore/modular-avatar.git
synced 2025-02-06 22:02:48 +08:00
docs: add logo usage guidelines and extending docs (#475)
This commit is contained in:
parent
c97a1fa82e
commit
68cb6c8530
50
docs/docs/distributing-prefabs/logo-usage.md
Normal file
50
docs/docs/distributing-prefabs/logo-usage.md
Normal file
@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Logo Usage Guidelines
|
||||
|
||||
The Modular Avatar logo is intended to indicate to users that products can be easily installed using Modular Avatar in a consistent way. To avoid confusion, please follow these guidelines when using the Modular Avatar logo in advertising your products.
|
||||
|
||||
While you are not required to request permission prior to using the logo in accordance with these guidelines, the final determination of whether logo usage is appropriate will be up to [bd_](https://misskey.niri.la/@bd_) and [pumo](https://twitter.com/pumony); upon request, you must remove your use of the logo.
|
||||
|
||||
Additionally, in some cases it may be possible to approve usage of the logo even if it does not meet the requirements stated here. Please contact bd_ if you have any questions or if you would like to discuss special usage permission.
|
||||
|
||||
## Applicable products
|
||||
|
||||
- The logo may be applied to advertise products like avatars or outfits that make use of Modular Avatar in a prefab.
|
||||
- The prefab in question must contain preconfigured Modular Avatar components.
|
||||
- You may include alternate prefabs that do not make use of Modular Avatar, but Modular Avatar should be a primary supported way of installing your asset.
|
||||
- The logo may also be applied to non-destructive editor extensions intended for use in avatar authoring
|
||||
which make use of [NDM Framework](https://github.com/bdunderscore/ndmf), and which are compatible with (or which require as a dependency) Modular Avatar.
|
||||
- When using with editor extensions, your editor extension must not make destructive changes to the original avatar. This means that uninstalling your asset must be achievable by deleting the prefab object from the avatar.
|
||||
- Your asset must not require the user to manually trigger any kind of processing or generation operation as part of installation or after changing settings.
|
||||
- Your asset must not use the Modular Avatar logo in any UI it adds. This is to make it clear which parts of the UI
|
||||
are from Modular Avatar itself.
|
||||
- The logo should not be presented in a way that makes it seem like Modular Avatar has approved of or endorsed your product.
|
||||
- Provided that your product meets the requirements stated here, you may use the logo to advertise both commercial and
|
||||
noncommercial products.
|
||||
|
||||
## Logo Placement
|
||||
|
||||
- The logo should be used in its entirety and must not be altered in any way.
|
||||
- As an exception, you may add an outline or shadow to the logo to improve visibility against the background.
|
||||
- The logo should not be animated or used as part of a pattern or background.
|
||||
- Exception: When used in a video, transition animations may be used, provided they do not make significant changes
|
||||
to the shape or style of the logo.
|
||||
- The logo should be used in a way that provides sufficient contrast and visibility.
|
||||
- The logo should be positioned at a reasonable distance from other elements to ensure clear visibility and legibility.
|
||||
|
||||
## Logo Colors
|
||||
|
||||
- The logo should always be used in its original colors. Several color variants are available for you to choose from; if these are unsuitable for your use, please reach out to bd_ to discuss options.
|
||||
- Please use the logo assets found here: [Download](/img/modular_avatar_logo.zip)
|
||||
|
||||
## Contact
|
||||
|
||||
For questions, please contact bd_ at:
|
||||
|
||||
* Discord: bd_
|
||||
* Twitter: @bd_j
|
||||
* Misskey: @bd_@misskey.niri.la
|
||||
* Email: bd_@nadena.dev
|
@ -1,4 +1,8 @@
|
||||
# Versioning policy
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Versioning policy
|
||||
|
||||
Modular Avatar subscribes to [Semantic Versioning](https://semver.org/). This means that:
|
||||
|
||||
|
31
docs/docs/extending.md
Normal file
31
docs/docs/extending.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Extending Modular Avatar
|
||||
|
||||
Modular Avatar can be extended by using [NDM Framework](https://github.com/bdunderscore/ndmf). Using NDMF, you can
|
||||
arrange for your code to be run before or after Modular Avatar processing. Generally speaking, if you intend to generate
|
||||
Modular Avatar components, it's best to execute your code in the Generating phase, like so:
|
||||
|
||||
```csharp
|
||||
|
||||
[assembly: ExportsPlugin(typeof(SetViewpointPlugin))]
|
||||
|
||||
namespace nadena.dev.ndmf.sample
|
||||
{
|
||||
public class MyPlugin : Plugin<MyPlugin>
|
||||
{
|
||||
protected override void Configure()
|
||||
{
|
||||
InPhase(BuildPhase.Generating)
|
||||
.BeforePlugin("nadena.dev.modular-avatar")
|
||||
.Run("Do something", ctx => { /* ... */ });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
In the future, additional APIs will be made available for deeper integration into Modular Avatar. If you have specific
|
||||
functionality that you want, please create an issue on [our github](https://github.com/bdunderscore/modular-avatar/issues).
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_position: 8
|
||||
sidebar_label: FAQ
|
||||
---
|
||||
|
||||
|
@ -0,0 +1,43 @@
|
||||
# ロゴ使用ガイドライン
|
||||
|
||||
Modular Avatarのロゴは、Modular Avatarを使って一貫した方法で簡単にインストールできることをユーザーに示すことを目的としています。混乱を避けるため、製品を宣伝する際にModular Avatarのロゴを使用する際のガイドラインを用意しています。
|
||||
|
||||
このガイドラインに沿った利用に関しては、事前許可なくロゴを利用できますが、ロゴの使用が適切であるかどうかの最終的な判断は[bd_](https://misskey.niri.la/@bd_)および[pumo](https://twitter.com/pumony)に委ねられます。不適切だと判断された場合は利用を中止していただく場合があります。
|
||||
|
||||
また、ガイドラインにそぐわない場合でも、ご連絡くだされば個別検討できる場合があります。下記の連絡先にてbd_にお気軽にご連絡ください。
|
||||
|
||||
## 適用製品
|
||||
|
||||
- Modular Avatarを使用して導入できるPrefabを含む製品(アバター、衣装など)の宣伝で使用できます。
|
||||
- ただし、該当Prefabに設定済みのModular Avatarコンポーネントを含む場合に限ります。
|
||||
- Modular Avatarを使用しない代替のPrefabなどを含めることができますが、Modular Avatarはアセットをインストールする主要な方法にする必要があります。
|
||||
- [NDM Framework](https://github.com/bdunderscore/ndmf)を使用し、Modular Avatarと互換性がある(または依存関係として要求する)アバター改変・作成用の非破壊エディタ拡張の宣伝にも使用できます。
|
||||
- エディタ拡張に適用する場合、元のアバターに対して破壊的な変更を加えてはいけません。Prefabなどの設定オブジェクト
|
||||
を削除することでアンインストールが完了する必要があります。
|
||||
- インストール手順の過程で、または設定を変更した際に、何らかの処理や生成操作を手動でトリガーすることを要求してはいけません。
|
||||
- エディタ内などの独自に実装したUIにはModular Avatarのロゴを仕様してはいけません(どこが本家Modular Avatarなのかを明白にするため)
|
||||
- Modular Avatarが製品を承認または推奨したと思われるような方法でロゴを提示してはいけません。
|
||||
- 製品の要件を満たしている場合は、営利・非営利にかかわらずロゴを使用することができます。
|
||||
|
||||
## ロゴの配置
|
||||
|
||||
- ロゴはそのまま使用してください。 変更や改変をしてはいけません。
|
||||
- ただし、背景に対して可視性を向上させるために、ロゴにアウトラインやシャドウを追加することはできます。
|
||||
- ロゴをアニメーション化したり、パターンや背景の一部として使用されたりしてはいけません。
|
||||
- ただし、動画で使う場合は、形やスタイルに大きな変更を加えない限り、トランジションアニメーションを使用することができます。
|
||||
- ロゴは十分なコントラストと可視性を提供する方法で使用する必要があります。
|
||||
- ロゴは、他の要素から合理的な距離を保って配置し、明確な可視性と可読性を確保する必要があります。
|
||||
|
||||
## ロゴの色
|
||||
|
||||
- ロゴは常に元の色で使用する必要があります。いくつかの色のバリエーションを用意していますが、使用に適さない場合は、bd_にご連絡ください。
|
||||
- 利用する際はこちらのロゴアセットをご利用ください:[ダウンロード](/img/modular_avatar_logo.zip)
|
||||
|
||||
## 連絡先
|
||||
|
||||
ご不明点や、上記の条件にそぐわない利用許可をお求めの場合は、bd_にてご連絡ください:
|
||||
|
||||
* Discord: bd_
|
||||
* Twitter: @bd_j
|
||||
* Misskey: @bd_@misskey.niri.la
|
||||
* Email: bd_@nadena.dev
|
@ -0,0 +1,34 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Modular Avatarを拡張する
|
||||
|
||||
Modular Avatar自体は[NDM Framework](https://github.com/bdunderscore/ndmf)で拡張できます。NDMFを使うことで、Modular Avatar
|
||||
の処理の前後に実行するように設定できます。Modular Avatarコンポーネントを生成する場合はGeneratingフェーズで実行することをお勧めします。
|
||||
たとえば、
|
||||
|
||||
```csharp
|
||||
|
||||
[assembly: ExportsPlugin(typeof(SetViewpointPlugin))]
|
||||
|
||||
namespace nadena.dev.ndmf.sample
|
||||
{
|
||||
public class MyPlugin : Plugin<MyPlugin>
|
||||
{
|
||||
protected override void Configure()
|
||||
{
|
||||
InPhase(BuildPhase.Generating)
|
||||
.BeforePlugin("nadena.dev.modular-avatar")
|
||||
.Run("Do something", ctx => { /* ... */ });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
In the future, additional APIs will be made available for deeper integration into Modular Avatar. If you have specific
|
||||
functionality that you want, please create an issue on [our github](https://github.com/bdunderscore/modular-avatar/issues).
|
||||
|
||||
今後、Modular Avatarにより深く拡張するための追加のAPIが提供される予定です。特定の機能が必要な場合は、
|
||||
[github](https://github.com/bdunderscore/modular-avatar/issues)にてissueを作成してください。
|
0
docs/static/img/modular_avatar_logo.zip
vendored
Normal file
0
docs/static/img/modular_avatar_logo.zip
vendored
Normal file
Loading…
Reference in New Issue
Block a user