Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brunomikoski/SpriteAuditor
The missing tool to help you optimize your game
https://github.com/brunomikoski/SpriteAuditor
atlases bundle editor editor-tool openupm optimization sprites unity unity3d unity3d-editor unity3d-npm-package
Last synced: 2 months ago
JSON representation
The missing tool to help you optimize your game
- Host: GitHub
- URL: https://github.com/brunomikoski/SpriteAuditor
- Owner: brunomikoski
- License: other
- Created: 2020-04-20T20:10:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-18T14:35:31.000Z (about 1 year ago)
- Last Synced: 2024-06-07T02:32:51.724Z (4 months ago)
- Topics: atlases, bundle, editor, editor-tool, openupm, optimization, sprites, unity, unity3d, unity3d-editor, unity3d-npm-package
- Language: C#
- Homepage:
- Size: 738 KB
- Stars: 110
- Watchers: 8
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.MD
- License: LICENSE
Awesome Lists containing this project
README
# Sprite Auditor
[](https://openupm.com/packages/com.brunomikoski.spriteauditor/)
 
[Wrote a small guide about how to use it](https://medium.com/@bada/optimizing-build-size-and-performance-with-proper-sprite-setup-7c76c91626b6)
Sprite auditor its the tool to give you the visibility when optimizing your atlases for smaller binary size or performance,
allowing you see what atlas are reused between multiple scenes, and what sprites are in use from that atlas, giving you the visibility to now only gain performance by making sure you are only using the right atlas on the right place,
but also helping you see witch texture are in use that could be smaller.
## Features
- Captures frame by frame all the sprites usages, so I can recognize when a Sprite has transform scales and can show what would be the ideals size for that sprite.
- Records the session of the game identifying sprites been used by the UI or SpriteRender giving you valuable information
- Allow customization of specific listeners to report special cases sprite usages
- Give you insights about images to canvas size, allow you understand if you can increase or decrease the image size
- Allows you see per scene what atlas are currently in use and what sprites are been used where.
- See what sprites are been used per scene and tweak your atlases to accomodate that properly.
- Can auto fix single sprites to the best possible usage
## How to use
- Set your target Resolution on the Game View
- Open the Sprite Auditor from the `Window / Analysis / Sprite Auditor` Menu
- Make sure you you select the `Record on Play` option enable.
- Play thought the project or let your Unit Test run to the project.
- After this you can start optimizing your atlas
## System Requirements
Unity 2018.4.0 or later versions
## How to install
Add from OpenUPM | via scoped registry, recommended
This package is available on OpenUPM: https://openupm.com/packages/com.brunomikoski.spriteauditor
To add it the package to your project:
- open `Edit/Project Settings/Package Manager`
- add a new Scoped Registry:
```
Name: OpenUPM
URL: https://package.openupm.com/
Scope(s): com.brunomikoski
```
- click Save
- open Package Manager
- click +
- select Add from Git URL
- paste `com.brunomikoski.spriteauditor`
- click Add
Add from GitHub | not recommended, no updates :(
You can also add it directly from GitHub on Unity 2019.4+. Note that you won't be able to receive updates through Package Manager this way, you'll have to update manually.
- open Package Manager
- click +
- select Add from Git URL
- paste `https://github.com/brunomikoski/SpriteAuditor.git`
- click Add