Console Log Saver

The tool to share Unity console log with friend who is good to error resolving.

エラー解決に強い友達とUnityのコンソールログを共有するためのツール

How to Use

1. If you're using Unity 2021 or later, make sure you have enabled Debugging in the Unity Editor. \ Please check lower-left corner of the Unity window and check if there's orange bug.

   

   If it's gray, click it and click Switch to debug mode to enable Debugging. If you cannot enable it (It happens in case of compilation error), restarting Unity Editor and entering safe mode will make it enabled.

2. Download latest zip from here
3. Extract the zip file
4. Double-click ConsoleLogSaver.Gui.exe
5. Select your Unity Project from the list.
6. Click Save to File & shere created file \ OR Copy to Clipboard and share using something like pastebin.com. \ If you can talk on discord, you can share by just pasting to the discord.
7. (Who can solve error) Read the log file using web viewer tool.

使い方

こちらのAzukimochiさんによるnote記事も参考にしてください

1. もしUnity 2021以降を使っている場合は、Unity Editorのデバッグモードが有効になっていることを確認する。\ Unityウィンドウの左下にオレンジ色の虫があるか確認してください。

   

   グレーの場合はクリックしてSwitch to debug modeをクリックしてデバッグモードにしてください。 有効にできない場合は(コンパイルエラーの場合に起こります)、 Unity Editorを再起動してセーフモードで起動すると有効になります。

2. 最新版のzipをここからダウンロードする
3. zipファイルを展開する
4. ConsoleLogSaver.Gui.exeをダブルクリックする
5. Unity Projectをリストから選択する
6. Save to Fileを押して生成されたファイルを共有する\ またはCopy to Clipboardしてpastebin.comなどで共有する。\ discordを使える場合には、discordにペーストするだけで共有できます。
7. (エラーを解決できる人が) web viewer tool を使用して出力を読む。

File Format

The exported file is designed as human-readable & machine-readable. This section shows how to read the file for humans. Doc for for creating parser is not yet provided.

The document is consists of multiple parts. First section as header (header section) and others are log content (content section).

For each section, there's header fields like HTTP/1.1's one and contents after two new lines (CRLF or LF).

In the header section, content should not be exists and you should ignore contents.

In the header section, there is a required field.

• Separator: shows the separator for each section. except for header section, the separator followed by new line (CRLF or LF) should not be exists in the both header fields and content.

Also, header section may have the following optional field.

• Unity-Version: The Unity Editor versionログの発生したUnityのバージョン
• Build-Target: The current build target ログを収集した時点でのビルド対象
• Editor-Platform: The OS information of the Unity Editor
• Hidden-Data: The data may be hidden (replaced with some text) in the log
• Upm-Dependency: Installed (locked) Unity Package Manager packages
• Vpm-Dependency: Installed (locked) VRChat Package Manager packages

In each content section, there is a required field.

• Content: shows the type of content. currently log-element is only used.

Also, content section with Content: log-element will have the following required fields

• Mode: The metadata of the log element. list of name of high bit.
• Mode-Raw: The metadata of the log element in hex.

ファイルフォーマット

生成されたファイルは機械でも人間でも判読可能に設計されてます。この章ではどのように人間がファイルを読めばいいかを示しています。パーサを書くためのドキュメントは用意されてません。

ドキュメントは複数の section に分けられており、最初のsectionがヘッダー(header section)で、残りがログの内容です(content section).

それぞれの section では HTTP/1.1と同様のヘッダフィールドが先頭にあり、2つの改行(CRLFまたはLF)の後、セクションの内容があります。

header sectionでは内容は空であるべきで、もしあっても無視するべきです。

header sectionでは以下の必須なフィールドがあります。

• Separator: section の区切りを示します。header section を除き、各セクションにはこの区切りに改行(CRLFまたはLF)が続くものは含まれてはいけません。

また、 header section では以下の任意のフィールドがあります。

• Unity-Version: ログの発生したUnityのバージョン
• Build-Target: ログを収集した時点でのビルド対象
• Editor-Platform: UnityEditorを実行している環境
• Hidden-Data: ログの内容で隠されてる可能性のある情報
• Upm-Dependency: インストールされてる (locked) Unity Package Manager のパッケージ
• Vpm-Dependency: インストールされてる (locked) VRChat Package Manager のパッケージ

各 content section では以下の必須なフィールドがあります。

• Content: 内容の種別を示します。 log-element のみが使用されてます

Content: log-elementなcontent section では以下の必須なフィールドがあります。

• Mode: そのログの要素のメタデータ。1になっているビットの名前の羅列
• Mode-Raw: そのログの要素のメタデータの16進数表記