https://github.com/bytebit-org/roblox-networkedsignals
A TypeScript wrapper of RemoteEvents to promise type safety
https://github.com/bytebit-org/roblox-networkedsignals
game-development lua networked-signals npm-package roblox roblox-ts
Last synced: about 9 hours ago
JSON representation
A TypeScript wrapper of RemoteEvents to promise type safety
- Host: GitHub
- URL: https://github.com/bytebit-org/roblox-networkedsignals
- Owner: Bytebit-Org
- License: mit
- Created: 2020-04-04T19:57:40.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-06T02:04:49.000Z (over 3 years ago)
- Last Synced: 2025-04-08T09:47:48.950Z (2 months ago)
- Topics: game-development, lua, networked-signals, npm-package, roblox, roblox-ts
- Language: TypeScript
- Homepage:
- Size: 472 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Networked Signals
A TypeScript wrapper for `RemoteEvent`s that provides a type-safe interface for networked signals in a Roblox game.
## Installation
### roblox-ts
Simply install to your [roblox-ts](https://roblox-ts.com/) project as follows:
```
npm i @rbxts/networked-signals
```
### Wally
[Wally](https://github.com/UpliftGames/wally/) users can install this package by adding the following line to their `Wally.toml` under `[dependencies]`:
```
NetworkedSignals = "bytebit/[email protected]"
```
Then just run `wally install`.
### From model file
Model files are uploaded to every release as `.rbxmx` files. You can download the file from the [Releases page](https://github.com/Bytebit-Org/roblox-NetworkedSignals/releases) and load it into your project however you see fit.
### From model asset
New versions of the asset are uploaded with every release. The asset can be added to your Roblox Inventory and then inserted into your Place via Toolbox by getting it [here.](https://www.roblox.com/library/7874130414/Networked-Signals-Package)
## Helpful Links
- [Documentation](DOCUMENTATION.md)
- [Tutorial](TUTORIAL.md)
# Why is this still version 0.x?
Because this package does not yet have thorough unit testing, it cannot really be trusted to be a 1.x release. Once thorough unit testing is added, then this package can have a high enough degree of trust to release version 1.0.0!