{"id":"omwot/images","name":"images","scope":"omwot","platform":"roblox","description":"Image asset management library","version":"1.0.0","latest":"1.0.0","versions":["1.0.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"df9a3a427844f8389bf7fe0251c3a079595d61045bf6ca110ca10d11f228ef04","likes":0,"downloads":0,"install":"forest install omwot/images","url":"https://forest.dev/p/roblox/omwot/images","files":"https://api.forest.dev/ai/package/roblox/omwot/images/files","readme":"# Images\r\nImage asset library for Roblox\r\n\r\n## Usage\r\nHere is example usage for the library\r\n```lua\r\n\r\nlocal Images = require(game:GetService('ReplicatedStorage').Packages.Images)\r\nlocal MyImageLabel = Instance.new('ImageLabel', game:GetService('StarterGui'))\r\n\r\n-- You can find availible\r\nlocal ImageData = Images:GetAsset('Qt://icons/Dark/Roblox/16/1x/Placeholder')\r\nMyImageLabel.Image = ImageData.Image\r\n\r\n-- It is important to note that `ImageRectOffset` and `ImageRectSize` may be `nil`\r\nMyImageLabel.ImageRectOffset = ImageData.ImageRectOffset or Vector2.new()\r\nMyImageLabel.ImageRectSize = ImageData.ImageRectSize or Vector2.new()\r\n\r\n-- You can also iterate through the data, however, the above method is preferred.\r\nfor Property, Value in ImageData do\r\n  MyImageLabel[Property] = Value\r\nend\r\n```\r\n\r\n## Adding your own sets\r\nYou can add your own sets using `Images:RegisterImageSet()`.\r\n```lua\r\nlocal Images = require(game:GetService('ReplicatedStorage').Packages.Images)\r\n\r\n-- This will create a set that can be accessed with a `MySet://` prefix\r\nImages:RegisterImageSet('MySet', {\r\n\tAnimalImages = {\r\n\r\n\t\t-- Access using `Images:GetAsset('MySet://AnimalImages/DuckImage')`\r\n\t\tDuckImage = {\r\n\t\t\tImage = 'rbxassetid://123456',\r\n\t\t\tImageRectOffset = Vector2.new(12, 34),\r\n\t\t\tImageRectSize = Vector2.new(32, 32),\r\n\t\t},\r\n\r\n\t\t-- Access using `Images:GetAsset('MySet://AnimalImages/DogImage')`\r\n\t\tDogImage = {\r\n\t\t\tImage = 'rbxassetid://665544332211',\r\n\t\t\tImageRectOffset = Vector2.new(43, 21),\r\n\t\t\tImageRectSize = Vector2.new(32, 32),\r\n\t\t},\r\n\t}\r\n\r\n\t-- Access using `Images:GetAsset('MySet://SmileFaceImage')`\r\n\tSmileFaceImage = {\r\n\t\tImage = 'rbxasset://textures/face.png',\r\n\t\t-- ImageRectOffset and ImageRectSize can be omitted\r\n\t}\r\n})\r\n\r\n-- We can now access the assets\r\nprint(Images:GetAsset('MySet://AnimalImages/DuckImage').Image) --> rbxassetid://123456\r\nprint(Images:GetAsset('MySet://AnimalImages/DogImage').Image) --> rbxassetid://665544332211\r\nprint(Images:GetAsset('MySet://SmileFaceImage').Image) --> rbxasset://textures/face.png\r\n\r\n```","readmeTruncated":false}