{"id":"stonetr03/debug-module","name":"debug-module","scope":"stonetr03","platform":"roblox","description":"Debug Lines","version":"2.0.1","latest":"2.0.1","versions":["2.0.0","2.0.1"],"license":"GPL-3.0","licenseRating":"unsafe","licenseCaveats":["Strong copyleft: shipping this in your game plausibly requires releasing your game's entire source under GPL-3.0. Not recommended for closed-source projects."],"licenseVerified":false,"dependencies":{"elttob/fusion":{"version":"^0.2.0","alias":"Fusion"}},"integrity":"96f8f55e4346772edd6e96d2fa78ff109c0671fdceef2e9e20706eee1f0b3a5c","likes":0,"downloads":0,"install":"forest install stonetr03/debug-module","url":"https://forest.dev/p/roblox/stonetr03/debug-module","files":"https://api.forest.dev/ai/package/roblox/stonetr03/debug-module/files","readme":"# Debug Module\r\n\r\nDebug Module for Roblox games.\r\n\r\nThis Module works both for Client and Server.\r\n\r\n![Screenshot](/Images/screenshot.png)\r\n\r\nThe Ui is toggleable via the keybinds `RightShift + p`\r\n\r\n> **Note**\r\n> The Keybinds can be changed in the Config.lua file.\r\n\r\n# Installation\r\n\r\n## Method 1: rbxlx File (Roblox Studio)\r\n\r\n- Download the rbxmx model file from the latest release from the [releases page](https://github.com/Stonetr03/Debug-Module/releases).\r\n- Insert the model into Roblox Studio and place into ReplicatedStorage.\r\n\r\n## Method 2: Rojo Sync\r\n\r\n- Copy the [Debug Folder](https://github.com/Stonetr03/Debug-Module/tree/master/src/debug) into your codebase.\r\n- Use a plugin like [Rojo](https://rojo.space/) to sync into Roblox.\r\n\r\n# Usage\r\n\r\nRequire the Debug Module from a Client or Server script.\r\n\r\n> **Warning**\r\n> Server lines are visible to all clients!\r\n\r\n> **Note**\r\n> For Server Lines to be visible, the module needs to be loaded/required on the client.\r\n\r\n```lua\r\nlocal Debug = require(path.to.module)\r\n```\r\n\r\n## Add a line\r\nTo add a line to the debug menu use, an call on server or client.\r\n```lua\r\nlocal Line = Debug:addLine(\"Name\",\"Value\")\r\n```\r\n> **Note**\r\n> The Value does not have to be a string.\r\n\r\n## Change Line's Text\r\nTo change a lines text use,\r\n```lua\r\nLine:Update(\"New Value\")\r\n```\r\n\r\n## Remove a Line\r\nTo remove a line use,\r\n```lua\r\nLine:Destroy()\r\n```\r\n","readmeTruncated":false}