Home

Welcome to the NSprites documentation! There you can read about framework, how to use it and how it works in details.

Note: This documentation expects that you are familiar with the basic concepts of DOTS.

So! NSprites is ECS based sprite rendering framework. It was designed to provide high level API in task of rendering dynamic sprites. NSprites lets you register components which system will sync data from and choose update strategies to gain maximum performance.

When to use NSprites

• Your project use sprites and it is near to pure ECS style, so you want everything be an entities
• You have A LOT of sprites which can be rendered with same material and same texture (like you making your Factorio game)

When not to use NSprites

• Most of your sprites use unique Material / Textures / Shaders, so it can't be rendered per one drawcall (or you don't want to make it so).
• You aiming to platform or/and graphics API which isn't supported by this framework
• You want solution fully out of the box without needing to implement shaders or/and custom systems

Getting started

I believe I've described basics in projects's ReadMe. Described solution is the most default you can reach without further wiki reading.