Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/needle-tools/compilation-visualizer
Unity Tool showing a timeline of assembly compilation. This is especially helpful when trying to optimize compile times and dependencies between assemblies. Besides showing a graphical view of compilation, selecting an assembly shows both dependencies and dependents of that assembly.
https://github.com/needle-tools/compilation-visualizer
assembly compact compilation-visualizer unity
Last synced: 5 days ago
JSON representation
Unity Tool showing a timeline of assembly compilation. This is especially helpful when trying to optimize compile times and dependencies between assemblies. Besides showing a graphical view of compilation, selecting an assembly shows both dependencies and dependents of that assembly.
- Host: GitHub
- URL: https://github.com/needle-tools/compilation-visualizer
- Owner: needle-tools
- License: mit
- Created: 2020-08-10T16:51:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-22T07:50:56.000Z (over 1 year ago)
- Last Synced: 2024-12-15T13:48:50.393Z (8 days ago)
- Topics: assembly, compact, compilation-visualizer, unity
- Language: C#
- Homepage:
- Size: 85.9 KB
- Stars: 900
- Watchers: 20
- Forks: 37
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Compilation Visualizer for Unity
 [](https://openupm.com/packages/com.needle.compilation-visualizer/)
## What's this?
This tool visualizes the assembly compilation process in Unity3D. It hooks into the Editor-provided events and nicely draws them on a timeline. That's especially helpful when trying to optimize compile times and dependencies between assemblies.
Besides showing a graphical view of compilation, selecting an assembly shows both dependencies and dependents of that assembly.
The screenshots show full compilations; but the timeline works as well for partial compilations (e.g. you changed a single script and Unity only recompiles the relevant parts of the dependency chain).
## Quick Start
Compilation Visualizer is available on OpenUPM: https://openupm.com/packages/com.needle.compilation-visualizer/
If you're on Unity 2019.4+:
- open `Edit/Project Settings/Package Manager`
- add a new Scoped Registry or add the package to the existing OpenUPM scope:
```
Name: OpenUPM
URL: https://package.openupm.com/
Scope(s): com.needle.compilation-visualizer
```
- click Save
- open Package Manager
- click +
- select Add from Git URL
- paste `com.needle.compilation-visualizer`
- click Add.
You can open the **Compilation Visualizer** by selecting `Window > Analysis > Compilation Timeline`. It will automatically update whenever something is compiled.
### Recompile
If you want to trigger a recompile, you can either use the Recompile button, or `Right Click > Reimport` a script or folder with scripts to cause that to be recompiled.
You can also compile **player scripts only**, by clicking Compile Player Scripts. Use the dropdown button to switch to another platform.
On 2021.2+, Unity changed how compilation results are cached. The Recompile and Compile Player Scripts will clear those caches to allow measuring a full compilation run.
### Navigation
Left Click to select a specific assembly. This will show dependencies and dependants.
Hover over an assembly to get additional details.
Alt + Scroll Wheel to zoom in/out.
Alt + Right Click to reset zoom.
Compact will toggle between a waterfall view of all assemblies, and a compact collapsed view that tries to save space.
Logging turns on a lot of extra logs that will be put into the Console when clicking on an assembly.
Show Reloads adds an extra section in the timeline to see how much time went into compilation and how much into the following Domain Reload.
### EditMode tests
Compilation Visualizer can run edit mode tests to ensure your project compiles on all platforms, catching common mistakes with ifdefs and API compatibility.
To use these tests, simply add it to the "testables" section in your project manifest.json:
```
"testables": [
"com.needle.compilation-visualizer"
],
```
Then, when you open `Window > General > Test Runner` you can click Run All or double-click `CompilePlayerScripts`.
## Screenshots
## Compatibility to 2018.4, 2019.1, 2019.2
While most functionality works great those versions, some minor things are different:
- slightly less accurate total compilation time on 2018.4 — 2019.1+ has events for the entire compilation while on 2018.4 the last finished assembly compilation is used as end date.
- no PackageInfo for now on 2018.4/2019.1 as `PackageInfo.FindForAsset` doesn't exist.
## Known Issues
On 2021.2, sometimes `UnityEditor.UI.dll` and `UnityEditor.TestRunner.dll` are included in Player Builds for reasons.
## Contact
[needle — tools for unity](https://needle.tools) •
[@NeedleTools](https://twitter.com/NeedleTools) •
[@marcel_wiessler](https://twitter.com/marcel_wiessler) •
[@hybridherbst](https://twitter.com/hybridherbst)