{"id":"nazumah/netflow","name":"netflow","scope":"nazumah","platform":"roblox","description":"Mirrored from the Wally registry.","version":"1.7.5","latest":"1.7.5","versions":["0.1.0","1.0.0","1.5.0","1.6.0","1.7.0","1.7.1","1.7.2","1.7.3","1.7.4","1.7.5"],"license":"MIT","licenseRating":"safe","licenseCaveats":["License identified from the packaged LICENSE file; the manifest declared none."],"licenseVerified":true,"dependencies":{"nazumah/async":{"version":"^1.0.4","alias":"Async"}},"integrity":"ed5525ba10e3460b5025523af570f1a3a6fe2bdb52d1f6c99be503036ef1510b","likes":0,"downloads":0,"install":"forest install nazumah/netflow","url":"https://forest.dev/p/roblox/nazumah/netflow","files":"https://api.forest.dev/ai/package/roblox/nazumah/netflow/files","readme":"# NetFlow\n\n[![Wally](https://img.shields.io/badge/Wally-1.7.5-blue.svg)](https://wally.run/package/nazumah/netflow)\n[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)\n[![Luau](https://img.shields.io/badge/Luau-Strict-blueviolet.svg)](https://luau-lang.org/)\n\nNetFlow is an ultra-high performance, buffer-based networking library for Luau on Roblox. By bypassing standard `RemoteEvent` serialization and using binary buffers, NetFlow achieves extreme bandwidth efficiency and processing speed.\n\n---\n\n## Technical Advantages\n\n- **Hashed Namespacing**: Uses 2-byte hashes for packet identification, eliminating string overhead and providing stable IDs across server and client.\n- **Buffer-Level Control**: Direct manipulation of Luau `buffer` objects ensures zero-copy serialization for primitive and complex types.\n- **3.3x Lower Bandwidth**: Real-world benchmarks show up to 3.3x reduction in network traffic compared to standard Roblox remotes.\n- **First-Class IntelliSense**: Unlike other networking libraries, NetFlow provides explicit type exports for its entire API, including the `Net.t` type-checking library.\n- **Async Integration**: Native support for request-response patterns using the [Async](https://github.com/Nazumah/roblox-luau-async) library.\n\n---\n\n## Installation\n\n### Wally\nUpdate your `wally.toml`:\n\n```toml\n[dependencies]\nNetFlow = \"nazumah/netflow@1.7.5\"\nAsync = \"nazumah/async@1.0.4\"\n```\n\n---\n\n## Quick Start\n\n### 1. Define a Packet\n```lua\nlocal Net = require(path.to.NetFlow)\nlocal ns = Net.namespace(\"Combat\")\n\nlocal DamagePacket = ns(\"Damage\", {\n    value = Net.t.struct({\n        TargetId = Net.t.uint32,\n        Amount = Net.t.float32,\n    }),\n    reliability = \"Unreliable\"\n})\n```\n\n### 2. Communicating\n```lua\n-- On Server\nDamagePacket.sendToAll({ TargetId = 1, Amount = 25.5 })\n\n-- On Client\nDamagePacket.listen(function(data)\n    print(\"Received damage:\", data.Amount)\nend)\n```\n\n---\n\n## Documentation\n\n- [Why Use NetFlow?](docs/WhyUseNetFlow.md)\n- [Supported Data Types](docs/DataTypes.md)\n- [API Reference](docs/API.md)\n\n---\n\n## License\nLicensed under the [MIT](LICENSE) License.","readmeTruncated":false}