https://github.com/excalith/slug-unity-log-parser
Creates markdown table for Unity3D log files
https://github.com/excalith/slug-unity-log-parser
Last synced: 9 months ago
JSON representation
Creates markdown table for Unity3D log files
- Host: GitHub
- URL: https://github.com/excalith/slug-unity-log-parser
- Owner: excalith
- Created: 2019-07-12T15:36:29.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-24T07:47:39.000Z (over 4 years ago)
- Last Synced: 2024-10-12T07:46:00.990Z (over 1 year ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SLUG - Unity Log Parser
A (very) simple tool written in rush for parsing Unity3D Engine logs to see player's journey easily within a markdown table. This is not intended to be a production-ready tool, but might come in handy for people who is struggling reading huge logs.
## Benefits
It formats each log entry into a markdown table row, without the stack trace bloating. This way you can read the sequence of things happened. It also captures the exceptions with the latest stack call - so you can see what threw the exception.
### Sample Data
Below is an example of what `Engine.log` looks like after exporting as markdown:
> **WARNING:** This log is only for checking out progression easily. You should examine the original `Engine.log` as well.
| ERROR | LINE | CLASS | LOG |
|---------|------|---------------------------|--------------------------------------------------------------------------------------------|
| |197931| Game Manager | Level Loaded: MyBeautifulLevel |
| |197931| Game Manager | Music Started: MyBeautifulAudio |
| |197931| Escape Menu | Escape Menu Instantiated |
| |197860| WorldTimeManager | Game Paused |
| |197931| Escape Menu | Escape Menu Destroyed |
|**ERROR**|212984| MissingReferenceException | The object of type 'MySh*ttyCode' has been destroyed but you are still trying to access it |
### The Catch
In order to use this tool, you should format your logs (Debug.Log etc.) like this:
```
Debug.Log("[CLASS NAME] Real Log Message")
```
Or optionally, you can check out [SLUG - Unity Logger](https://github.com/excalith/slug-unity-logger) which does the same thing, except for writing down `[Class Name]` manually.
Either way, slug can parse all log messages starting with `[` and create a markdown table.
## How To Use
### Install
To install, run the command
```
npm i -g slug-unity-log-parser
```
### Usage
To run the app, use `slug` command with the `Engine.log` file path
```
slug path/to/engine.log
```