ガイド
ガイドは、FloatSoda を知ってから、作ったツールを配って保守するまでを案内するタブです。段階ごとに7つのグループがあるので、自分の段階に近いグループのページを選んでください。
ガイドの読み方
Section titled “ガイドの読み方”グループは時間の順に並んでいます。「1. 探す」から「7. メンテナンスする」までのうち、自分の段階に近いグループの節へ進んでください。
各グループの中は、手順を渡すページ(How-to)を先に、考え方を説明するページ(解説)を後に並べています。部品の一覧や制約の一覧のような調べ物は、ガイドの外のリファレンスにあります。ガイドからは、必要な場面でリンクします。最初の1本を手を動かして作るチュートリアルも別のタブにあります。
FloatSoda をまだ知らない、または名前だけ知っている段階です。自分の目的に合うかを確かめます。
- FloatSoda とは: FloatSoda が何で、どんな人が何を作れるか
- オーバーレイとは: SteamVR のオーバーレイが何で、ゲームの画面とどう違うか
作例を見たいときは、リファレンスの作例のカタログを開いてください。確かめたら、次は「2. 採用する」です。
2. 採用する
Section titled “2. 採用する”使うかどうかを決める段階です。
- ほかの作り方と比べる: uGUI で作る場合や OpenVR を直接呼ぶ場合と比べて、何が楽になり、何を引き受けるか
作りたいものが今できるかは、リファレンスのできないこと・まだ使えないもので確かめられます。使うと決めたら「3. 準備する」へ進みます。
3. 準備する
Section titled “3. 準備する”使うと決めて、書き始める前に整える段階です。自分の経験に合うページを選んでください。
| 自分の状況 | 開くページ |
|---|---|
| PC に .NET を入れて、動かせる状態にしたい | 開発環境を用意する |
| コードは AI に書かせたい | AI に FloatSoda を書かせる |
| VRChat と組み合わせたい | VRChat と組み合わせるときに確かめること |
| Unity の uGUI で UI を作ってきた | uGUI から来た人へ |
| C# がほぼ初めてで、AI が書いたコードを読みたい | C# がほぼ初めての人へ |
Flutter から来た人は、リファレンスのFlutter の読み替え表が近道です。用語は用語集、対応する環境は動作環境にあります。準備ができたら、チュートリアル最初のオーバーレイを作るで最初の1本を作り、次に「4. 作る」へ進みます。
最初の1本を終えて、作りたいものがある段階です。作る順(見た目、動き、操作、確かめ、起動)に並べています。
画面を組み立てる
入力を受け取り、確かめる
仕組みを知り、足す
使いたい部品は、リファレンスの部品を目的から探すで探せます。詰まったら「5. 困ったとき」、できたら「6. 配る」へ進みます。
5. 困ったとき
Section titled “5. 困ったとき”エラーが出る、反応しない、思った大きさにならない、重い、といった症状が出た段階です。症状に合うページを選んでください。
- エラーを読んで直す
- 反応しないときに切り分ける
- 負荷を抑える
- レイアウトの考え方: 思った大きさや位置にならないとき
Flutter の書き方で動かないときは、Flutter の読み替え表を開いてください。ここで解けなければ、「docs で見つからないとき」へ進みます。
動くツールができて、人に渡す、売る、自動で起動する段階です。
配ったあとは「7. メンテナンスする」へ進みます。
7. メンテナンスする
Section titled “7. メンテナンスする”配った相手の環境で動かない、または久しぶりに自分のツールを触る段階です。
- 利用者の環境で動かないとき
- 画面と状態の分け方: 直しやすい形に整えるとき
久しぶりに触るときは、チュートリアルで手順を、リファレンスで API と制約を確かめてください。FloatSoda の版を上げるときは、CHANGELOG.md も読んでください。直した版を届ける手順は、exe にして配るの後半にあります。
docs で見つからないとき
Section titled “docs で見つからないとき”docs を読んでも解けない問題は、次の2か所に持ち込めます。
- GitHub の Issue: バグの報告と機能の要望を受け付けています。使い方や設計の相談も Issue に書いてください。GitHub の Discussions は有効にしていません。
- AI への質問: 公開サイトの
llms.txt(索引)かllms-full.txt(全文)を AI に渡して聞けます。渡し方はAI に FloatSoda を書かせるにあります。
Issue には、FloatSoda のバージョン、dotnet --version の出力、OS、再現するコードか手順を書いてください。表示の問題では、GPU、HMD、SteamVR のバージョンも添えると原因をたどれます。Issue の書式は、バグ報告と機能要望の2つのテンプレートで選べます。Issue を出す前に確かめたい決まりは、CONTRIBUTING.mdにあります。