{"id":"secret-rare/filoxen-luau","name":"filoxen-luau","scope":"secret-rare","platform":"roblox","description":"Mirrored from the Wally registry.","version":"0.1.6","latest":"0.1.6","versions":["0.1.1","0.1.2","0.1.3","0.1.4","0.1.5","0.1.6"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{"secret-rare/rbx-asset-utils":{"version":"^0.2.0","alias":"RbxAssetUtils"}},"integrity":"8c78027e925eb6e5d8ded2584ecf214b2ab2984bddc61cedca1998a28135eb25","likes":0,"downloads":0,"install":"forest install secret-rare/filoxen-luau","url":"https://forest.dev/p/roblox/secret-rare/filoxen-luau","files":"https://api.forest.dev/ai/package/roblox/secret-rare/filoxen-luau/files","readme":"# filoxen-luau\r\n\r\nLuau client library for the Filoxen asset API. Fetch random or search for Roblox assets.\r\n\r\n## Installation\r\n\r\nRequires [Wally](https://wally.run).\r\n\r\n```toml\r\n[dependencies]\r\nFiloxen = \"secret-rare/filoxen-luau@0.1.6\"\r\n```\r\n\r\n```sh\r\nwally install\r\n```\r\n\r\n## Setup\r\n\r\n1. Add your Filoxen API key as a secret in the [Creator Dashboard](https://create.roblox.com) under Secrets (defaults to `FILOXEN_API_KEY`).\r\n2. Make sure `HttpService` is enabled for your game.\r\n\r\n## Usage\r\n\r\n```luau\r\nlocal Filoxen = require(path.to.Filoxen)\r\n\r\n-- Must be called once before any other function\r\nFiloxen.configure({\r\n    baseUrl = \"https://your-filoxen-instance.com\",\r\n    apiKeySecretName = \"FILOXEN_API_KEY\", -- optional, this is the default\r\n})\r\n\r\n-- Fetch 10 random hats\r\nlocal assets = Filoxen.random(\r\n    { Enum.AssetType.Hat },  -- assetTypeIds\r\n    nil,                     -- maxAssetId\r\n    nil,                     -- minAssetId\r\n    10,                      -- batch\r\n    true                     -- onsale\r\n)\r\n\r\n-- Search for assets by name\r\nlocal results = Filoxen.search(\"blue hat\", Enum.AssetType.Hat.Value)\r\n```\r\n","readmeTruncated":false}