{"id":"superdupernairobi/raylens","name":"raylens","scope":"superdupernairobi","platform":"roblox","description":"Raycast and shapecast debugging for Roblox, client sided handle adornments, Studio only","version":"0.1.0","latest":"0.1.0","versions":["0.1.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"cb1f200ace454992aee2a25e85e4f8c7c77efafe82a7973b85175d11985218f6","likes":0,"downloads":0,"install":"forest install superdupernairobi/raylens","url":"https://forest.dev/p/roblox/superdupernairobi/raylens","files":"https://api.forest.dev/ai/package/roblox/superdupernairobi/raylens/files","readme":"![RayLens logo](assets/logo.png)\r\n![Animated demo of RayLens drawing rays](docs/RayLens.gif)\r\n\r\n# RayLens\r\nRaycast and shape cast debugging for Roblox, if you cast the ray, RayLens draws it.\r\n\r\nIt uses client side handle adornments, so the visuals only exist on your client, other players never see them.\r\n## Install\r\n```toml\r\n[dependencies]\r\nraylens = \"superdupernairobi/raylens@0.1.0\"\r\n```\r\nStudio users: download `RayLens.rbxm` from the release, right click `ReplicatedStorage` in the Explorer and pick Insert > Import Roblox Model.\r\n## Quickstart\r\n```lua\r\nlocal rayLens = require(game.ReplicatedStorage.raylens)\r\n\r\nlocal origin = Vector3.new(0, 5, 0)\r\nlocal direction = Vector3.new(0, -50, 0)\r\n\r\nrayLens.draw(origin, direction, workspace:Raycast(origin, direction))\r\n```\r\nThe ray appears, sits there for the `lifetime` (default is 8), and then clears itself.\r\n## Notes\r\n- **It does not cast for you.** `draw` takes the result you already have. Pass `nil` and it draws the full length with no marker, so a miss looks different from a hit.\r\n- **Client sided.** Put it in a client script (LocalScript), a server script will look right in studio and do nothing once you play.\r\n- **One shot or per frame.** `draw` called once draws one ray that expires after `lifetime`, for anything moving, use `onDraw` and draw inside the callback.\r\n## API\r\n`draw`, `ray`, `line`, `box`, `sphere`, `cone`, `cylinder`, `clear`, `onDraw` - see the [API reference](https://superdupernairobi.github.io/RayLens/api/RayLens)\r\n## License\r\nMIT","readmeTruncated":false}