Skip to content

Commit

Permalink
Docs updates for 1.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
bdunderscore committed Aug 18, 2021
1 parent e7251fb commit b6a758e
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 6 deletions.
5 changes: 5 additions & 0 deletions docs/docs/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,8 @@ By default, tutorial guidance will be shown the first time a user picks up a pro
<figcaption>Disabling the tutorial system</figcaption>
</figure>

# Troubleshooting

## When props are disabled and enabled, they do not respond to any input (without error logs)

Please make sure you are not setting the props to be inactive immediately after scene load. [Due to an outstanding Udon bug](https://feedback.vrchat.com/vrchat-udon-closed-alpha-bugs/p/1123-udon-objects-with-udon-children-initialize-late-despite-execution-order-ove), marking an object inactive in the same frame as its UdonBehaviours were scheduled to Start can result in the UdonBehaviours entering a broken state permanently. It is however safe if they are initially disabled (ie, already disabled in the editor).
18 changes: 13 additions & 5 deletions docs/docs/en/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# Upgrade guide

## 1.0 → 1.1
## 1.11.1.1

To upgrade from 1.0 to 1.1:
To upgrade from 1.1 to 1.1.1, simply import the 1.1.1 unitypackage over the 1.1 package.

* First, ensure that you update [UdonSharp](https://github.com/MerlinVR/UdonSharp/releases) to 0.20.1 or higher.
* Import the 1.1 unitypackage over the existing 1.0 package. Your scenes should upgrade automatically.
### Major changes in 1.1.1

* Workarounds for various Udon bugs.

## 1.0 → 1.1.1

To upgrade from 1.0 to 1.1 (or 1.1.1):

* First, ensure that you update [UdonSharp](https://github.com/MerlinVR/UdonSharp/releases) to 0.20.2 or higher.
* Import the 1.1.1 unitypackage over the existing 1.0 package. Your scenes should upgrade automatically.

### Major changes in 1.1

Expand All @@ -15,4 +23,4 @@ To upgrade from 1.0 to 1.1:
* Directionality now favors the positive Z direction from the directionality marker, instead of both positive and negative Z directions.
* The bone selection interface now considers bones from multiple nearby players, making selection more intuitive.
* The "Prefer self" option has been removed (it's much less necessary now that bone selection considers multiple players).
* Props now find the global controller automatically on scene load; if you delete and recreate the controller, you don't need to mess with each individual prop to fix things.
* Props now find the global controller automatically on scene load; if you delete and recreate the controller, you don't need to mess with each individual prop to fix things.
8 changes: 8 additions & 0 deletions docs/docs/jp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,11 @@ Attachment Directionオブジェクトがボーン選択に指向性を与えま
<img src="../tutorial off.png">
<figcaption>チュートリアルを無効化する</figcaption>
</figure>

# よくある問題

## ON/OFFがついた場合、エラーが出ずに、アタッチオブジェクトが一切反応しない

シーンが読み込んだ直後に非アクティブ化しないようにしてください。[Udonのバグのせいで](https://feedback.vrchat.com/vrchat-udon-closed-alpha-bugs/p/1123-udon-objects-with-udon-children-initialize-late-despite-execution-order-ove)、Startが呼ばれたはずのフレームで非アクティブ化すると永久的に壊れてしまう場合があります。

なお、エディター上で最初から非アクティブになっている場合は問題になりません。
10 changes: 9 additions & 1 deletion docs/docs/jp/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# 更新ガイド

## 1.0 → 1.1
## 1.1 → 1.1.1

1.1から1.1.1にアップグレードする場合は、そのまま1.1.1のunitypackageを上書きインポートしてください。

### 1.1.1での主な更新点

* Udonのバグを迂回する調整

## 1.0 → 1.1 (または1.1.1)

1.0から1.1に更新する場合は以下の手順おを踏んでください

Expand Down

0 comments on commit b6a758e

Please sign in to comment.