{"id":"ptekspy/remote","name":"remote","scope":"ptekspy","platform":"roblox","description":"Remote","version":"1.1.0","latest":"1.1.0","versions":["1.1.0"],"license":"Apache-2.0","licenseRating":"safe","licenseCaveats":["Modified files must carry a notice of changes. If the package ships a NOTICE file, its attributions must be preserved."],"licenseVerified":true,"dependencies":{},"integrity":"e5f8a9423bec978f924bb22fe9289a79895fb193b3a176896be234d3cd8c4839","likes":0,"downloads":0,"install":"forest install ptekspy/remote","url":"https://forest.dev/p/roblox/ptekspy/remote","files":"https://api.forest.dev/ai/package/roblox/ptekspy/remote/files","readme":"# Remote\r\n\r\nA lightweight Roblox utility for managing `RemoteEvent` creation and client-server event wiring. This package centralizes remote events in `ReplicatedStorage/RemoteEvents`, prevents duplicate server-side remote names, and gives clients a safe wrapper to connect and fire server events.\r\n\r\n## Features\r\n\r\n- Creates `RemoteEvent` or `UnreliableRemoteEvent` on the server.\r\n- Prevents duplicate remote names on the server.\r\n- Client-side modules can wait for the remote to appear and connect to `OnClientEvent`.\r\n- Provides a clean server/client API without requiring consumers to manage the `RemoteEvents` folder manually.\r\n\r\n## Install\r\n\r\nInstall the package with wally:\r\n\r\n```bash\r\nwally add ptekspy/remote\r\n```\r\n\r\n## Usage\r\n\r\nRequire the package from your project path:\r\n\r\n```lua\r\nlocal Remote = require(path.to.Remote.src.init)\r\n```\r\n\r\n### Server\r\n\r\n```lua\r\nlocal remote = Remote.New(\"ChatMessage\")\r\nremote:FireServer(\"hello\")\r\n```\r\n\r\n### Client\r\n\r\n```lua\r\nlocal remote = Remote.New(\"ChatMessage\")\r\nremote.OnClientEvent:Connect(function(message)\r\n\tprint(\"Server sent:\", message)\r\nend)\r\nremote:FireServer(\"hello from client\")\r\n```\r\n\r\n## API\r\n\r\n`Remote.New(name: string, is_unreliable: boolean?)`\r\n\r\n- `name` — Remote event name.\r\n- `is_unreliable` — optional boolean to create an `UnreliableRemoteEvent`.\r\n- server-side returns the created `RemoteEvent` instance.\r\n- client-side returns a wrapper object with `OnClientEvent.Connect()` and `FireServer()`.\r\n\r\n## Notes\r\n\r\n- `Remote.New()` throws on the server if a remote with the same name already exists.\r\n- Client-side `FireClient()` and `FireAllClients()` are not supported and will throw if called.\r\n- All events are stored under `ReplicatedStorage/RemoteEvents`.\r\n\r\n## Contributing\r\n\r\nThis repository is intended for Roblox developers who want a minimal remote event helper with built-in duplicate detection and client-side connect/wait behavior.\r\n","readmeTruncated":false}