tooling/bins/zap/README.md

32 lines
No EOL
1.5 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
<h1>Zap</h1>
</div>
Zp is a blazingly fast networking solution for Roblox.
## Features
- Zap packs data into buffers with no overhead. The same data can be sent using a fraction of the bandwidth.
- Zap doesn't compromise on performance. Zap's packing and unpacking is typically faster than Roblox's generic encoding.
- Extended support of data types sendable through the network.
- For both the IDL and API, Zap is a joy to use. It's easy to learn, easy to use, and easy to debug. It's the best DX you'll find.
- Zap is fully secure. Buffers make reverse engineering your game's networking much harder and Zap validates all data received.
## Find Zap at...
Zap is currently undergoing a rewrite, which can be found at the [rewrite branch](https://github.com/red-blox/zap/tree/rewrite).
Otherwise versions `0.6.x` are being maintained by [@sasial-dev](https://github.com/sasial-dev), on the [0.6.x branch](https://github.com/red-blox/zap/tree/0.6.x).
## Documentation
Documentation can be found [here](https://zap.redblox.dev/). Please note these docs are for `0.6.x`.
## Contributing
Contributions are welcome! Please open an issue or discuss in the [Roblox Open Source Software Community Discord](https://discord.gg/Evc9jdPmgZ) before you start working on a feature or bug fix so we can discuss it.
## Logo
Zap's Logo is sourced from [Twitter](https://github.com/twitter/twemoji/blob/master/assets/svg/26a1.svg) and is under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.