Skip to content

Commit ee76dca

Browse files
committed
Merge branch 'master' of https://github.com/ffrostflame/ByteNet
2 parents 62050c7 + 5c26693 commit ee76dca

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
1+
2+
<div align="center">
3+
4+
<img align="center" src="./docs/assets/bytenetLogo.png" width=100 height=100></img>
5+
16
# ByteNet
27

3-
## An advanced, modern networking library for Roblox
8+
## Simple, buffer-based networking.
9+
10+
[GitHub](https://github.com/ffrostflame/ByteNet) | [Documentation](https://ffrostflame.github.io/ByteNet/)
411

5-
---
12+
</div>
613

7-
## Features
8-
- Strictly typed in Luau
9-
- Supports Reliability types
10-
- Packets are structured in key-value pairs, except the keys are serialized away
11-
- Written entirely w/ buffers (Compression woohoo)
12-
- Queues events per-frame
13-
- Ordered
14+
ByteNet is an networking library which takes your Luau data, and serializes it into buffers. On the other end, ByteNet deserializes your data, and then feeds it back to your Luau code. You don't need to worry about type validation, optimization, packet structure, etc. ByteNet does all the hard parts for you! Strictly typed with an incredibly basic API that explains itself, ByteNet makes networking simple, easy, and quick. There's very few concepts you need to grasp in order to use ByteNet; it has an incredibly minimalistic & simplistic, yet powerful API.
1415

15-
---
16+
## Installation
17+
You can install ByteNet on Wally, or through the latest release's `.rbxm` file.
1618

1719
## Performance
1820

19-
### **Speed**
21+
ByteNet performs incredibly well compared to non-buffer based libraries like BridgeNet2. This is because ByteNet has a **custom serializer** that takes your Luau data and transforms it into a buffer, sending that and deserializing it on the other side.
2022

21-
ByteNet is incredibly performant, running **purely** on buffers with zero table manipulation.
23+
## Further contact
2224

23-
### **Bandwidth**
25+
You can contact me directly under the ByteNet thread in the [Roblox OSS Server](https://discord.gg/5KjV64PA3d).
2426

25-
ByteNet lets **you** specify exact data types, such as **int8**, **uint32**. Packet IDs are **1 byte**.
27+
Further documentation [here](https://ffrostflame.github.io/ByteNet/docs/).
2628

27-
---
28-
Further documentation [here](https://ffrostflame.github.io/ByteNet/docs/intro).
29+
## License
30+
This project is under the MIT license! so, it's open source.

0 commit comments

Comments
 (0)