https://github.com/seaofvoices/chroma-luau

A Luau library for color manipulation
https://github.com/seaofvoices/chroma-luau

Last synced: about 1 month ago
JSON representation

A Luau library for color manipulation

• Host: GitHub
• URL: https://github.com/seaofvoices/chroma-luau
• Owner: seaofvoices
• License: other
• Created: 2024-07-29T20:08:06.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T12:50:23.000Z (4 months ago)
• Last Synced: 2024-11-10T19:22:37.622Z (about 2 months ago)
• Language: Luau
• Size: 116 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-luau - `chroma-luau` - luau?label=) | (JavaScript)
• awesome-luau - `chroma-luau` - luau?label=) | (Data)

README

        
[![checks](https://github.com/seaofvoices/chroma-luau/actions/workflows/test.yml/badge.svg)](https://github.com/seaofvoices/chroma-luau/actions/workflows/test.yml)

![version](https://img.shields.io/github/package-json/v/seaofvoices/chroma-luau)

[![GitHub top language](https://img.shields.io/github/languages/top/seaofvoices/chroma-luau)](https://github.com/luau-lang/luau)

![license](https://img.shields.io/npm/l/chroma-luau)

![npm](https://img.shields.io/npm/dt/chroma-luau)

# chroma-luau

A library to work with all kinds of color conversions and color scales.

This library is a translation of [chroma.js](https://github.com/gka/chroma.js).

## [Documentation](./docs/index.md)

- [color constructors](./docs/constructors.md)

- [manipulate the color object and convert into different color spaces](./docs/color.md)

- [generate colors and scales](./docs/generators.md)

- [utils](./docs/utils.md)

## Installation

Add `chroma-luau` in your dependencies:

```bash

yarn add chroma-luau

```

Or if you are using `npm`:

```bash

npm install chroma-luau

```

## Releases

Versions of chroma-luau are also pre-built and linked to [GitHub releases](https://github.com/seaofvoices/chroma-luau/releases):

- `chroma.rbxm` is a Roblox model file

- `chroma.lua` is a single-file version of the library (with Luau type annotations removed)

## Other Lua Environments Support

If you would like to use this library on a Lua environment, where it is currently incompatible, open an issue (or comment on an existing one) to request the appropriate modifications.

The library uses [darklua](https://github.com/seaofvoices/darklua) to process its code.

## License

This project is available under the MIT license. See [LICENSE.txt](LICENSE.txt) for details.