{"id":"jakeywastaken/ceiveimoverlay","name":"ceiveimoverlay","scope":"jakeywastaken","platform":"roblox","description":"Mirrored from the Wally registry.","version":"0.0.1","latest":"0.0.1","versions":["0.0.1"],"license":"MIT","licenseRating":"safe","licenseCaveats":["License identified from the packaged LICENSE file; the manifest declared none."],"licenseVerified":true,"dependencies":{},"integrity":"c4f94abe097c4b9f28c5abd77b3cfd13e4ae9f188d4a6815b0acec007a9be0fc","likes":0,"downloads":0,"install":"forest install jakeywastaken/ceiveimoverlay","url":"https://forest.dev/p/roblox/jakeywastaken/ceiveimoverlay","files":"https://api.forest.dev/ai/package/roblox/jakeywastaken/ceiveimoverlay/files","readme":"# CeiveImOverlay\r\nCeiveImOverlay is a quick and easy way of creating a debug overlay for miscellaneous information. No need to create your own ui or keep track of connections, simply call 3 functions and you have all the information you could ever need.\r\n\r\nA basic integration of CeiveImOverlay would be as follows:\r\n\r\n```lua\r\nlocal RunService = game:GetService(\"RunService\")\r\nlocal CeiveImOverlay = require(...)\r\nlocal ImOverlay = CeiveImOverlay.new()\r\n\r\nImOverlay.BackFrame.Parent = AScreenGui\r\n\r\n-- Could be heartbeat or render stepped, doesnt really matter.\r\nRunService.RenderStepped:Connect(function()\r\n    ImOverlay:Text(\"Hello World!\")\r\n\r\n    ImOverlay:Render()\r\nend)\r\n```\r\nWhich would result in this:\r\n\r\n<div align=\"center\">\r\n    <img src=\"https://github.com/JakeyWasTaken/CeiveImOverlay/blob/main/docs/assets/basic_example.png?raw=true\"/>\r\n</div>\r\n\r\nA more complex integration could look something like this:\r\n```lua\r\nlocal RunService = game:GetService(\"RunService\")\r\nlocal CeiveImOverlay = require(...)\r\nlocal ImOverlay = CeiveImOverlay.new()\r\n\r\nImOverlay.BackFrame.Parent = AScreenGui\r\n\r\n-- Could be heartbeat or render stepped, doesnt really matter.\r\nRunService.RenderStepped:Connect(function()\r\n    for i = 1, 10 do\r\n        ImOverlay:Begin(`Recursive {i}`)\r\n    end\r\n\r\n    ImOverlay:Text(\"Im ontop of the world!\")\r\n\r\n    for _ = 1, 10 do\r\n        ImOverlay:End()\r\n    end\r\n\r\n    ImOverlay:Render()\r\nend)\r\n```\r\nWhich would result in this:\r\n\r\n<div align=\"center\">\r\n    <img src=\"https://github.com/JakeyWasTaken/CeiveImOverlay/blob/main/docs/assets/complex_example.png?raw=true\"/>\r\n</div>\r\n\r\nYou can find the demo place here: https://www.roblox.com/games/16359051355/CeiveImOverlay\r\n","readmeTruncated":false}