{"id":"xactlyblue/sketch","name":"sketch","scope":"xactlyblue","platform":"roblox","description":"A simple solution to visual debugging in Roblox.","version":"1.0.6","latest":"1.0.6","versions":["1.0.0","1.0.1","1.0.2","1.0.3","1.0.4","1.0.5","1.0.6"],"license":"MIT","licenseRating":"safe","licenseCaveats":["The package archive does not include its license text; the license is declared in its manifest metadata."],"licenseVerified":false,"dependencies":{},"integrity":"06db6e41dd25ac7cfe3f41163129ae1368b0032ca86cbcd39674f32515f3f62d","likes":0,"downloads":0,"install":"forest install xactlyblue/sketch","url":"https://forest.dev/p/roblox/xactlyblue/sketch","files":"https://api.forest.dev/ai/package/roblox/xactlyblue/sketch/files","readme":"<div align=\"center\">\r\n    <h1>Sketch</h1>\r\n    <p>A visual debugging library for Roblox</p>\r\n</div>\r\n\r\nSketch is a visual debugging library for Roblox, allowing you to render visual representations of rays, text and shapes with ease.\r\nThis project is still in it's infancy, and is just meant to be a quick utility library.\r\n\r\n## Purpose\r\nVisually representing information in the 3D World has always been a bit of a hassle on Roblox. After all, even simple visible text\r\nneeds to be mounted on a [BillboardGui](https://create.roblox.com/docs/reference/engine/classes/BillboardGui) which then needs to be\r\nattached to an Adornee. This library aims to solve this problem without being destructive or harmful to your normal workflow.\r\n\r\n## Documentation\r\nThe project's early documentation can be found [here](https://xactlyblue.github.io/sketch). It's is still rather early in development, and though it is completely functional, \r\nit does not yet have thorough documentation beyond the APIs (and some examples you can find in the ``src/example/`` folder). Hopefully proper documentation can be sorted out some time soon.\r\n\r\n## Installation\r\n\r\n### Wally\r\n[Wally](https://github.com/UpliftGames/wally) is a package manager for Roblox, allowing you to integrate this (and countless other unique and helpful libraries)\r\ndirectly into your project through a controlled system. To use this library in wally, you can simply add the following to your `wally.toml`:\r\n\r\n```toml\r\nSketch = \"xactlyblue/sketch@1.0.0\"\r\n```\r\n\r\n### Rojo\r\nIf you don't want to use a package manager like Wally, you can git-clone the source code directly into the folder you'd prefer and [Rojo](https://rojo.space) can take care of the rest.\r\n\r\n```git clone \"https://github.com/xactlyblue/sketch\"```\r\n","readmeTruncated":false}