NSprites Foundation
This package provides various solutions for Unity DOTS sprite rendering based on the NSprites package. While NSprites tries to be a flexible solution for all of your 2D sprite rendering needs, this project is more like a set of samples and useful tools. These tools may or may not be perfect for your use-case.
How to Use
I would recommend downloading this as an embedded package and adapting it to your needs. You can use most parts separately except those which depend on each other (details below). You can also implement your own tools on top of those or from scratch looking here for an example.
Also, before working with this package please read the NSprites documentation to understand what is going on (or use this package without editing :D).
Package Contents
| name |
running |
description |
| Components |
runtime |
Contains components to be used with NSprites |
| Authoring |
editor |
Bakes basic render data, uses all other parts |
| Render data registration |
runtime |
Register render data for NSprites render system |
| Sorting |
runtime |
Calculate SortingValue depending on 2D position to use in shader |
| Culling |
runtime |
Disables or Enables rendering based on 2D position relative to the camera (disabled by default due to performance) |
| Animation |
runtime |
Shifts UV values to simulate sprite animation |
| Graphics |
runtime |
Provides shaders / materials / other render assets |
Installation
Requirements
- Window -> Package Manager -> + button -> Add package from git url
- Paste
https://github.com/Antoshidza/NSprites-Foundation.git
Install via git submodule
cd to your project's /Packages folder- Run
git submodule https://github.com/Antoshidza/NSprites-Foundation.git
Install via .unitypackage (recommended)
- Open the release you want on the Releases page in this repository
- Expand the Assets foldout and download the *.unitypackage file
- Import it to your project by opening the file while the unity editor is open, or use Assets -> Import Package
Note: You can select which files to import, and can use this to filter out unwanted assets. The Package will be installed as local to the /Packages folder as usual, but in this case the package will be already cached so you can freely modify it.
Quick Start
This guide will help you create a new project using NSprites Foundation, and render a single sprite to ensure the system is working.
- Create a new project using one of the supported Unity versions listed above. Make sure to use the 3D Cross-Platform URP template. The 2D URP project template is incompatible with the built-in shader in NSprites Foundation.
- Add NSprites to the project, using one of the recommended install methods. This will also automatically add the required ECS/DOTS packages to the repository if they have not yet been added.
- Add NSprites Foundation to the project, using one of the recommended install methods.
- Typically, it's a good idea to restart Unity at this point since you've sometimes added/updated Burst.
- Change the main camera to Orthographic view. Perspective view is incompatible with the built-in culling system. You may also want to change the scene view to 2D.
- In the current scene, add a subscene for entity baking, and into that subscene, add a blank game object.
- On this default game object, add a new component of type
Sprite Renderer Authoring.
- On this new component, set the required fields:
- Set the
Sprite field to either a built-in sprite or one of your own sprites!
- Set the
Sprite Render Data / Material to the included RegularSprite_Material
- Set the
Sprite Render Data / Properties Set to the included RegularSprite_PropertiesSet
- Make sure all sprites which uses same basic authoring assets (which makes them use same
RenderArchetype) are one the same texture. If they not then use any atlasing tool.
- Press play and make sure your sprite shows up!
Good to Know
- You can use the included shaders only with URP, so before rendering anything you should import, create and assign the URP asset in the project settings.
If you want to use another render pipeline, then you need to implement your own shader and create a material to use with it.
- Some components are registered as properties in this package, so by default you will have component properties (you can see them this window).
This means that some shader property names are already registered with some components and you can't use similar names for different formats in other shaders you want to use with NSprites.
If you don't want to have default registered components you can exclude the manifest file from the asset (use *.unitypackage installation for that).