# Nino **Ultimate high-performance binary serialization library for C#** [![Build Status](https://camo.githubusercontent.com/1b10cd993e8cb409b8146827a5055fcf9e9e3fc9355905ceb89785f3e99e18ed/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f4a61736f6e5875446576656c6f7065722f4e696e6f2f2e6769746875622f776f726b666c6f77732f63692e796d6c3f6272616e63683d6d61696e267374796c653d666c61742d737175617265)](https://github.com/JasonXuDeveloper/Nino/actions) [![License](https://camo.githubusercontent.com/e57b2efb392728aff83f738fd0e10ef2181dce5c45ed88170b0887b788e6980c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f4a61736f6e5875446576656c6f7065722f4e696e6f3f7374796c653d666c61742d737175617265)](https://github.com/JasonXuDeveloper/Nino/raw/main/LICENSE) [![NuGet](https://camo.githubusercontent.com/2b102638fa7d4514c919377ed97890ed686e0d07a9f231d3261ca2a59bebfaf8/68747470733a2f2f696d672e736869656c64732e696f2f6e756765742f762f4e696e6f3f6c6162656c3d4e75476574267374796c653d666c61742d737175617265266c6f676f3d6e75676574)](https://www.nuget.org/packages/Nino) [![OpenUPM](https://camo.githubusercontent.com/32e5ecb9ec54c64801276fd9e605a8efe13d064d5bcc2bce85adef07d3dda223/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f636f6d2e6a61736f6e7875646576656c6f7065722e6e696e6f3f6c6162656c3d4f70656e55504d267374796c653d666c61742d737175617265266c6f676f3d756e6974792672656769737472795f7572693d68747470733a2f2f7061636b6167652e6f70656e75706d2e636f6d)](https://openupm.com/packages/com.jasonxudeveloper.nino/) [🌐 **Official Website**](https://nino.xgamedev.net/en/) • [📚 **Documentation**](https://nino.xgamedev.net/en/doc/start) • [🚀 **Performance**](https://nino.xgamedev.net/en/perf/micro) • [🇨🇳 **中文**](https://github.com/JasonXuDeveloper/Nino/blob/main/README.zh.md) *Fast, flexible, and effortless C# binary serialization*

--- ## ✨ Why Choose Nino?

🔧 Seamless Integration

Leverages C# Source Generators for automatic compile-time code generation. Zero manual setup required.

⚡ Blazing Performance

Engineered for high-throughput, low-latency scenarios with minimal GC pressure and memory allocation.

🎮 Unity Compatible

Works seamlessly with Unity projects and native Unity data types like Vector3 and Quaternion.

🛠️ Advanced Features

Handles complex scenarios like polymorphism, versioning, custom constructors, and private member serialization.

--- ## 🎯 Core Features ### 🚀 **Performance & Reliability** - **High-Speed Serialization**: Consistently ranks among the fastest C# binary serializers - **Low Memory Footprint**: Minimal GC pressure and memory allocation - **By-Reference Deserialization**: Deserialize directly into existing objects to eliminate allocation overhead - **Thread-Safe Operations**: Fully concurrent serialization/deserialization without external locking - **Data Integrity**: Built-in type checking ensures data consistency ### 🧩 **Comprehensive Type Support** - **Primitives & Built-ins**: Full support for all C# primitive types (`int`, `float`, `DateTime`, etc.) - **Modern C# Features**: `records`, `record structs`, `structs`, `classes`, and generics - **Collections**: Any `IEnumerable` including `List`, `Dictionary`, `HashSet`, `ConcurrentDictionary` - **Advanced Generics**: Complex nested types like `Dictionary>` - **Value Types**: `ValueTuple`, `Tuple`, `KeyValuePair`, `Nullable` ### 🎮 **Unity & Cross-Platform** - **Unity Native Types**: `Vector3`, `Quaternion`, `Matrix4x4`, and other Unity-specific data types - **Cross-Assembly Support**: Serialize types across different .NET assemblies and projects - **Platform Agnostic**: Works seamlessly across different .NET implementations ### ⚙️ **Advanced Control** - **Polymorphism**: Interface and abstract class serialization with type preservation - **Custom Constructors**: `[NinoConstructor]` for immutable types and factory patterns - **Versioning & Migration**: `[NinoMember]` ordering and `[NinoFormerName]` for backward compatibility - **Privacy Control**: `[NinoType(true)]` to include private/protected members - **Selective Serialization**: `[NinoIgnore]` to exclude specific fields - **String Optimization**: `[NinoUtf8]` for efficient UTF-8 string handling --- ## 📖 Quick Start ### Installation **Standard .NET Projects:** ```bash dotnet add package Nino ``` **Unity Projects (via OpenUPM):** ```bash openupm add com.jasonxudeveloper.nino ``` ### Basic Usage ```csharp [NinoType] public class GameData { public int Score; public string PlayerName; public DateTime LastPlayed; } // Serialize var data = new GameData { Score = 1000, PlayerName = "Player1", LastPlayed = DateTime.Now }; byte[] bytes = NinoSerializer.Serialize(data); // Deserialize var restored = NinoDeserializer.Deserialize(bytes); ``` **[📚 Full Documentation →](https://nino.xgamedev.net/en/doc/start)** --- ## 📊 Performance Nino consistently delivers exceptional performance across various scenarios. See detailed benchmarks and comparisons with other popular serialization libraries. **[🚀 View Benchmarks →](https://nino.xgamedev.net/en/perf/micro)** --- ## 🤝 Community & Support

[![GitHub Issues](https://camo.githubusercontent.com/f19d0667be417b89aaf8206a7a81595dbe79fd9ebffb2cb9b3822d42b47e6ded/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f4a61736f6e5875446576656c6f7065722f4e696e6f3f7374796c653d666c61742d737175617265)](https://github.com/JasonXuDeveloper/Nino/issues) [![GitHub Stars](https://camo.githubusercontent.com/ae3e0871e83cfacaf4db87e9d525dc95f6735fe819ad07136a7d29d1cd0ed74d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f4a61736f6e5875446576656c6f7065722f4e696e6f3f7374796c653d666c61742d737175617265)](https://github.com/JasonXuDeveloper/Nino/stargazers) [![GitHub Forks](https://camo.githubusercontent.com/df4e6c3295c45f504ae29bebab080d835f9a336485e15c5853e9c06524578117/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f4a61736f6e5875446576656c6f7065722f4e696e6f3f7374796c653d666c61742d737175617265)](https://github.com/JasonXuDeveloper/Nino/network) **[🐛 Report Issues](https://github.com/JasonXuDeveloper/Nino/issues)** • **[💡 Feature Requests](https://github.com/JasonXuDeveloper/Nino/issues)** • **[🔀 Contribute](https://github.com/JasonXuDeveloper/Nino/pulls)**

---

**Made with ❤️ by [JasonXuDeveloper](https://github.com/JasonXuDeveloper)** *Licensed under [MIT License](https://github.com/JasonXuDeveloper/Nino/raw/main/LICENSE)*