Skip to content

Commit 7a7989b

Browse files
g0dzZz-coderg0dzZz-coder
committed
Added readme's
1 parent 16e4775 commit 7a7989b

5 files changed

Lines changed: 206 additions & 0 deletions

File tree

‎Docs.meta‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Docs/README.RU.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Unity Serialization Surrogates
2+
3+
<div>
4+
<strong><a href="README.md">English</a> | <a href="README.RU.md">Русский</a></strong>
5+
</div>
6+
7+
<details>
8+
<summary>Содержание</summary>
9+
10+
- [Введение](#введение)
11+
- [Особенности](#особенности)
12+
- [Установка](#установка)
13+
- [Сотрудничество](#сотрудничество)
14+
- [Поддержка](#поддержка)
15+
- [Лицензия](#лицензия)
16+
17+
</details>
18+
19+
## Введение
20+
21+
Содержит суррогаты сериализации для структур **Unity**.
22+
23+
## 🦾 Особенности
24+
25+
Предоставляемые суррогаты обеспечивают сериализацию и десериализацию следующих типов:
26+
27+
- Color
28+
- Quaternion
29+
- Vector2
30+
- Vector2Int
31+
- Vector3
32+
- Vector3Int
33+
- Vector4
34+
35+
## 📥 Установка
36+
37+
Скачайте любую версию из [релизов](https://github.com/Depression-aggression/Serialization.Unity.Surrogates/releases).
38+
39+
#### Установка через URL git:
40+
41+
Также вы можете добавить этот пакет, открыв **PackageManager**,
42+
перейдя к опции `Добавить пакет из URL git` и введите:
43+
44+
`https://github.com/Depression-aggression/Serialization.Unity.Surrogates.git`
45+
46+
## 🔰 Использование
47+
48+
Сериализация:
49+
50+
```csharp
51+
using (var memoryStream = new MemoryStream())
52+
{
53+
// Настройте суррогаты сериализации структур Unity.
54+
var surrogateSelector = new SurrogateSelector();
55+
surrogateSelector.AddAllUnitySurrogates();
56+
var binaryFormatter = new BinaryFormatter { SurrogateSelector = surrogateSelector };
57+
58+
// Сериализуйте и поместите в пакет.
59+
binaryFormatter.Serialize(memoryStream, data);
60+
memoryStream.Flush();
61+
memoryStream.Seek(0, SeekOrigin.Begin);
62+
var bytes = memoryStream.ToArray();
63+
}
64+
65+
Десериализация:
66+
67+
```csharp
68+
using (var memoryStream = new MemoryStream(bytes))
69+
{
70+
// Настройте суррогаты сериализации для структур Unity.
71+
var surrogateSelector = new SurrogateSelector();
72+
surrogateSelector.AddAllUnitySurrogates();
73+
var binaryFormatter = new BinaryFormatter { SurrogateSelector = surrogateSelector };
74+
75+
// Десериализуйте.
76+
var data = binaryFormatter.Deserialize(memoryStream);
77+
}
78+
```
79+
80+
## 🤝 Сотрудничество
81+
82+
Я приветствую запросы на добавление новых функций и сообщения об ошибках
83+
в разделе [issues](https://github.com/Depression-aggression/Serialization.Unity.Surrogates/issues) этого репозитория,
84+
а также принимаю [pull requests](https://github.com/Depression-aggression/Serialization.Unity.Surrogates/pulls).
85+
86+
## 🫂 Поддержка
87+
88+
Я независимый разработчик,
89+
и большая часть разработки этого проекта выполняется в моём свободном времени.
90+
Если вас интересует сотрудничество или вы хотите нанять меня для выполнения проекта,
91+
пожалуйста, ознакомьтесь с [моим портфолио](https://github.com/Depression-aggression) и [свяжитесь со мной](mailto:g0dzZz1lla@yandex.ru)!
92+
93+
## 🪪 Лицензия
94+
95+
Этот проект под лицензией **[Apache-2.0](https://github.com/Depression-aggression/SerializedReference.Dropdown/blob/main/LICENSE)**.
96+
97+
Авторские права (c) 2023 Николай Мельников
98+
[g0dzZz1lla@yandex.ru](mailto:g0dzZz1lla@yandex.ru)

‎Docs/README.RU.md.meta‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Docs/README.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Unity Serialization Surrogates
2+
3+
<div>
4+
<strong><a href="README.md">English</a> | <a href="README.RU.md">Русский</a></strong>
5+
</div>
6+
7+
<details>
8+
<summary>Table of Contents</summary>
9+
10+
- [Introduction](#introduction)
11+
- [Features](#-features)
12+
- [Installation](#-installation)
13+
- [Contribute](#-contribute)
14+
- [Support](#-support)
15+
- [License](#-license)
16+
17+
</details>
18+
19+
## Introduction
20+
21+
Contains serialization surrogates for **Unity**'s structs.
22+
23+
## 🦾 Features
24+
25+
The provided surrogates provide serialization and deserialization of the following types:
26+
27+
- Color
28+
- Quaternion
29+
- Vector2
30+
- Vector2Int
31+
- Vector3
32+
- Vector3Int
33+
- Vector4
34+
35+
## 📥 Installation
36+
37+
Download any version from [releases](https://github.com/Depression-aggression/Serialization.Unity.Surrogates/releases).
38+
39+
#### Install via git URL:
40+
41+
Alternatively, you can add this package by opening the **PackageManager**,
42+
going to the `Add package from git URL` option, and entering:
43+
44+
`https://github.com/Depression-aggression/Serialization.Unity.Surrogates.git`
45+
46+
## 🔰 Usage
47+
48+
Serialization:
49+
50+
```csharp
51+
using (var memoryStream = new MemoryStream())
52+
{
53+
// Setup Unity's structs serialization surrogates.
54+
var surrogateSelector = new SurrogateSelector();
55+
surrogateSelector.AddAllUnitySurrogates();
56+
var binaryFormatter = new BinaryFormatter { SurrogateSelector = surrogateSelector };
57+
58+
// Serialize and put to packet.
59+
binaryFormatter.Serialize(memoryStream, data);
60+
memoryStream.Flush();
61+
memoryStream.Seek(0, SeekOrigin.Begin);
62+
var bytes = memoryStream.ToArray();
63+
}
64+
```
65+
66+
Deserialization:
67+
68+
```csharp
69+
using (var memoryStream = new MemoryStream(bytes))
70+
{
71+
// Setup Unity's structs serialization surrogates.
72+
var surrogateSelector = new SurrogateSelector();
73+
surrogateSelector.AddAllUnitySurrogates();
74+
var binaryFormatter = new BinaryFormatter { SurrogateSelector = surrogateSelector };
75+
76+
// Deserialize.
77+
var data = binaryFormatter.Deserialize(memoryStream);
78+
}
79+
```
80+
81+
## 🤝 Contribute
82+
83+
I welcome feature requests and bug reports
84+
in [issues](https://github.com/Depression-aggression/Serialization.Unity.Surrogates/issues) section,
85+
as well as [pull requests](https://github.com/Depression-aggression/Serialization.Unity.Surrogates/pulls).
86+
87+
## 🫂 Support
88+
89+
I am an independent developer,
90+
and most of the development on this project is done in my spare time.
91+
If you're interested in collaboration or hiring me for a project,
92+
please check out [my portfolio](https://github.com/Depression-aggression) and [reach out](mailto:g0dzZz1lla@yandex.ru)!
93+
94+
## 🪪 License
95+
96+
This project is licensed under the **[Apache-2.0](https://github.com/Depression-aggression/SerializedReference.Dropdown/blob/main/LICENSE)** license.
97+
98+
Copyright (c) 2023 Nikolay Melnikov
99+
[g0dzZz1lla@yandex.ru](mailto:g0dzZz1lla@yandex.ru)

‎Docs/README.md.meta‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)