Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

sr4dev/Unity-SpriteAssist

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Unity-SpriteAssist

openupm

ℹ️About

Unity-SpriteAssist is an Unity extension that assist Sprite's mesh creation more conveniently.

🖥️System Requirements

Unity 2021.3 LTS or later versions

📝Features

  • Control Vertex Easily with a Sliderbar.
  • Make a transparent, opaque, complex(transparent + opaque) mesh
  • Convert Sprite to MeshRenderer Prefab

📷Screenshots

image image

📦Installation

Unity Package Manager

You can add https://github.com/sr4dev/Unity-SpriteAssist.git?path=Assets/SpriteAssist to Package Manager. image

OpenUPM

https://openupm.com/packages/com.sr4dev.unity-spriteassist/

openupm add com.sr4dev.unity-spriteassist

Manual installation

Clone or download this repository and copy Assets/SpriteAssist folder to your Unity project.

✏️How to use

  • Select a Sprite asset in the Project window.
  • Select a Mode and adjust parameters.

Mode

image

  • Transparent Mesh: Default Mode. Allow alpha pixel.
  • Opaque Mesh: Disallow alpha pixel. You can use the mesh for opaque shader.
  • Complex: Separate area by alpha.
    • Alpha pixel is converted to Transparent Mesh area.
    • Non-alpha pixel is converted to Opaque Mesh area.
    • To Use Complex mode must be created Mesh Prefab.
    • Complex mode dose not override original Sprite mesh.

Parameter

image

  • Detail: Density and accuracy of the mesh to the Sprite outline.
  • Alpha Tolerance: Threshold for transparency considered when generating the outline.
  • Detect Holes: Detect holes from outline.
  • Edge Smoothing: Smoothing sharp edges.
  • Non-zero Winding: Use Non-zero winding rule. Default Winding rule is even-odd.

Even-odd(left), Non-zero(right)

image

Wikipedia: Non-zero winding

Mesh Prefab

image

  • Prefab: Linked Prefab with Sprite.
  • Create/Remove: Create or remove a Prefab.
  • Default Transparent Shader
  • Default Opaque Shader

⚠️Caution!

AssetImporter.userData

This extension uses AssetImporter.userData of Texture asset. If your project already uses userData, it will be overridden.

Unity Document: AssetImporter.userData

Known Issues

  • Does not support SpriteAtlas.
  • Does not support PSD file.

For other issues, please refer to the link. https://github.com/sr4dev/Unity-SpriteAssist/issues

🗺️Roadmap

  • Support pre-packed Sprite.
  • Support Sprite Mode: Multiple.
  • Add Sprite Animation example.
  • Add tutorial(pdf, movies...).
  • Release to the Asset Store.

🔣License

MIT License

📚Library

☕Donation

Buy Me a Coffee at ko-fi.com

About

Unity Sprite mesh extension

Topics

Resources

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.