Skip to content

Commit bf21478

Browse files
committed
Merge branch 'master' of github.com:Sacred-Seed-Studio/Unity-File-Debug
2 parents 8987c18 + 3c4c7c3 commit bf21478

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
11
# Unity-File-Debug
2-
Enhanced debug logging for Unity, with JSON export and HTML viewer
2+
Enhanced debug logging for Unity, with JSON export and HTML viewer.
33

44
## Why
5-
This project has a few goals
5+
This project has a few goals:
66
- Output Unity debug info to log files
7-
- Have a nice interface to view the logs
8-
- No external dependencies
7+
- A nice web interface to view the logs
98
- HTML5
9+
- No external dependencies
1010
- Searchable via message, stacktrace, timestamp, logtype
1111
- Filterable by logtype
1212

1313
## How to use
1414
1. Import the [latest release's package](https://github.com/Sacred-Seed-Studio/Unity-File-Debug/releases) into your project
15-
2. Move the prefab into your scene
16-
3. Setup the filepath and settings in the prefab instance inspector
17-
4. Copy the HTML to your output path via inspector
15+
2. Move the prefab `Unity File Debug` into your scene
16+
3. Setup the filepath and settings in the inspector
17+
4. Copy the HTML to your output path via inspector button
1818
5. Use `Debug.Log` as normal, or for more advanced usage see Tester script in `Demo` folder
19-
6. Open the HTML file from your log folder, open a JSON log in the top left
19+
6. Open the `index.html` file from your log folder, browse for a `*.json` log in the top left
20+
21+
## Developing
22+
- Fork/clone this repository
23+
- Open in Unity
24+
- Hack away
25+
26+
## Release
27+
In the Unity Editor, click the menu option `Package/Update Package`. The `UnityFileDebug.unitypackage` will be in the root of this project.

0 commit comments

Comments
 (0)