Installation

From GitHub

Download the Signal.rbxm model from the Latest Release, and place it in your desired location. You can then require the module and use the API.

With Wally

Add the following to your wally.toml dependencies:

Signal = "nowoshire/namedsignal@^2.0.0"

Then run wally install in your Terminal.

TIP: Wally Package Types Fixer

Wally packages lose their type exports, to fix this, you can use the wally-package-types CLI tool.

You can install this tool using a toolchain manager:

with cargo

cargo install wally-package-types

with rokit

rokit add JohnnyMorganz/wally-package-types

Then run:

rojo sourcemap default.project.json --output sourcemap.json
wally-package-types --sourcemap sourcemap.json Packages/

See the README.md file in JohnnyMorganz's repository for more information.

From Source (Building with Rojo)

If you prefer, you can build NamedSignal directly from source using Rojo.

git clone https://github.com/averlyst/NamedSignal.git
cd NamedSignal
rojo build --output "Signal.rbxm"

Then insert the built Signal.rbxm into your desired location.