[image: Wally] [image: Roblox]

Credits

This library would not have existed without this library; lucide-roblox came to be after I found myself wanting different sizes of the icons, but Tarmac was broken and didn't allow me to resize the icons, leading to me writing my own way of creating these icons.

If you are looking for 48px and 256px icons, please use the original library. This library is a bandaid fix and once Tarmac is fixed, there is no reason to use this over the original library.

Installation

Wally (recommended)

lucide-roblox is available on Wally, and can be installed by adding lucide-roblox = "virtualbutfake/lucide-roblox@0.1.0" to your wally.toml.

Roblox

lucide-roblox is available through Roblox if you don't use Wally, and can be installed by adding the latest release to your game and then requiring it.

Usage

lucide-roblox is extremely straightforward:

local lucide = require(path.to.lucide-roblox)
local icon = lucide.GetAsset("name", size) -- conveniently mimics the original lucide-roblox API, so you can easily port your code back later

The complete list of icons can be found here

Updating

In order to update the definitions of the icons, you can run the following command:

lune run lune/setup.lua

This will pull the latest icons, process them, add them to Tarmac and update the icons in the package. If any new icons appear, feel free to open a PR to add them.

License

lucide-roblox is licensed under the MIT License. See LICENSE for more information.