Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reedo0910/colorlift

🎨 AI-powered accessible color descriptions. 借助 AI 生成无障碍的颜色描述。
https://github.com/reedo0910/colorlift

accessibility ai colorpicker electron utilities

Last synced: about 1 month ago
JSON representation

🎨 AI-powered accessible color descriptions. 借助 AI 生成无障碍的颜色描述。

Host: GitHub
URL: https://github.com/reedo0910/colorlift
Owner: Reedo0910
License: gpl-3.0
Created: 2024-12-11T08:56:34.000Z (about 2 months ago)
Default Branch: master
Last Pushed: 2024-12-20T19:28:21.000Z (about 2 months ago)
Last Synced: 2024-12-20T20:27:02.710Z (about 2 months ago)
Topics: accessibility, ai, colorpicker, electron, utilities
Language: JavaScript
Homepage:
Size: 2.79 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![ColorLift icon](docs/images/icon.png)

# 拾彩

> 通过 AI 生成的颜色文字描述，帮助用户（特别是色觉障碍者）理解屏幕上的颜色及其应用场景。

![应用界面](docs/images/promote_zh-CN.png)

拾彩（ColorLift）是一款免费的跨平台辅助工具，支持 Windows 和 macOS。本项目致力于通过直观的文字描述，帮助用户更好地理解和应用色彩。*以及提供一个十分赏心悦目的用户界面。*

## 🌐 Translations Available

- [English](docs/README_EN.md)
- [繁體中文](docs/README_ZH-TW.md)

## 下载

可以通过 [GitHub Release 页面](https://github.com/Reedo0910/ColorLift/releases) 下载拾彩的 Windows 和 macOS 安装包与便携版压缩包。

## 特点

- 🎨 **一键拾色**：点击屏幕上的任意位置，获取对应的 HEX/RGB/HSL 颜色值。
- 🔍 **颜色识别辅助**：通过文字描述帮助用户（特别是色觉障碍者）理解颜色。
- 🌈 **语境化颜色描述**：提供颜色的常见使用场景，帮助用户更好地理解色彩在实际中的应用。
- 🌍 **多语言支持**：目前支持英文、简体中文和繁体中文，欢迎贡献其他语言的翻译或帮助纠错。
- 🤖 **多模型支持**：API 支持 Anthropic、Cohere、科大讯飞星火、OpenAI 和智谱 AI。
- 💻 **跨平台兼容**：支持 Windows 和 macOS。

## 界面预览

![应用界面2](docs/images/promote_zh-CN_2.png)

**支持在 HEX、RGB 和 HSL 颜色格式之间切换。**

*（演示中使用的语言模型为 Claude 3.5 Sonnet）*

## 系统要求

- Windows 7 及以上版本
- macOS 10.11 (El Capitan) 及以上版本

## 支持的 LLM 列表

拾彩支持以下语言模型：

- **Anthropic**: Claude 3.5 系列
- **Cohere**: Command R 系列
- **科大讯飞星火**: Lite、Pro、Max、4.0 Ultra
- **OpenAI**: GPT-4o 系列
- **智谱 AI**: GLM-4 系列

*由于底层架构和训练数据的差异，不同语言模型生成的文本质量可能会有所不同。*

## 注意

- 本应用是免费的开源工具。但调用语言模型 API 时，可能会产生由相应提供商收取的费用。请在使用前详细了解提供商的语言模型 API 资费说明。
- 所有色彩描述文本与推荐均由 AI 生成，请核查重要信息以确保准确性。
- **本工具不适用于精确色彩测量或专业色彩指导**。

## 使用前准备

使用拾彩前，请确保拥有所需大语言模型（LLM）提供商的 API Key。以下是支持的厂商及其获取 API Key 的链接（需要注册相关的开发者账号）：

- **Anthropic**: [获取 API Key](https://console.anthropic.com/dashboard) | [资费说明](https://www.anthropic.com/pricing#anthropic-api)
- **Cohere**: [获取 API Key](https://dashboard.cohere.com/api-keys) | [资费说明](https://cohere.ai/pricing)
- **科大讯飞星火**: [获取 API Key](https://console.xfyun.cn/services) （到控制台具体模型下获取 http 服务接口认证信息中的 APIPassword） | [资费说明](https://xinghuo.xfyun.cn/sparkapi?scr=price)
- **OpenAI**: [获取 API Key](https://platform.openai.com/api-keys) | [资费说明](https://openai.com/api/pricing/)
- **智谱 AI**: [获取 API Key](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys) （账号设置 > 项目管理 > API keys）| [资费说明](https://open.bigmodel.cn/pricing)

## 使用方法

1. 在拾彩应用主界面的右下角的设置中选择语言模型的提供商与模型，并输入从相应提供商获取的 API Key （请首先确保您所在的地区与网络能够访问到该语言模型服务）。
2. 使用界面上的拾色工具（或使用自带的快捷键：Windows 默认：`ALt + D` / macOS 默认： `Option + C`）从屏幕中选取任意颜色。
3. 拾彩应用将提供并生成以下信息：
- 该颜色的 HEX、RGB 与 HSL 值。
- 详细的文字描述，包括颜色的描述以及常见应用场景。
4. 拾彩应用支持一键复制颜色的代码与生成的描述

## macOS 用户可能会遇到的问题

### 安装应用/更新后，首次启动时显示安全警告

由于拾彩目前未启用代码签名（因为作为兴趣使然的个人项目，我并未支付 Apple 开发者账号的年费），因此在 macOS 上首次运行时，会触发系统的安全警告。

您只需要进行一些简单的设置即可使用它，请参阅官方文档：[打开来自未知开发者的 Mac App](https://support.apple.com/guide/mac-help/mh40616/mac)。

### 系统设置中显示拾彩已经获得了“录屏与系统录音”的权限，为什么仍然提示需要获取权限？（或为什么无法正常取色？）

**该问题通常在安装应用更新后出现，您需要重置拾彩的系统权限：**

(macOS 15.0 及以上) 请依次前往 **系统设置 > 隐私与安全性 > 录屏与系统录音**，选中 **ColorLift（拾彩）**，点击左下角的 **减号键（-）** 移除 ColorLift。随后使用拾彩取色，此时 ColorLift 会重新出现在列表中。最后，开启列表中 **ColorLift** 的权限。

其他 macOS 版本的步骤细节和界面表述可能会有些许不同。

### 为什么安装更新那么繁琐？

这是由于拾彩目前未启用代码签名，故每次安装（更新）后，macOS 会将其视为一个全新的程序，无法识别拾彩先前获得的权限。

如果自动获取更新的问题对您造成困扰，请在设置中关闭“应用启动时检查更新”。自行在“关于”窗口手动检查更新，或通过 [GitHub Release 页面](https://github.com/Reedo0910/ColorLift/releases) 下载最新的版本。

## 隐私

1. **屏幕权限**：

- 在 macOS 上，拾彩需要访问“录屏与系统录音”权限。主要用于取色功能。若不授予权限，取色将无法正常进行。（获取到的颜色与点击的屏幕区域不符。）
- 取色时，应用仅读取鼠标指针前 1x1 像素图像内的颜色值，并将该颜色值的 HEX、RGB 与 HSL 文本传递给 LLM 进行解析。（除了保障隐私，这种方法也对您 API 的使用资费很友好。）

2. **LLM 的 API Key**：

- 您的 API Key 仅存储在本地，用于调用相关模型服务。

## 常见问题 (FAQ)

1. **无法获取到某些屏幕区域的颜色（例如菜单栏或图标）？**

当拾彩的鼠标点击取色不可用时，可将鼠标移到想要取色的区域上，再使用快捷键（Windows 默认：`ALt + D` / macOS 默认： `Option + C`）进行取色。

2. **关于 Linux 的支持**

拾彩使用 Electron 开发，原理上能够支持 Linux 。但由于我没有相关的开发环境进行适配调整和测试，所以暂时未提供 Linux 的安装包。当然，欢迎PR。

3. **关于手机系统的支持**

拾彩不支持在手机系统上运行。但您可以透过诸如macOS上的「[iPhone 镜像](https://support.apple.com/120421)」等投屏类应用，实现从桌面端对手机屏幕取色。

4. **关于应用自动更新**

由于经费原因，拾彩未启用代码签名。根据 Electron 官方限制，未签名的应用无法在 macOS 上提供自动更新服务。目前拾彩会在启动app时在后台检查更新，但需要用户手动下载更新文件并安装。您也可以在设置中禁用应用更新，并在关于窗口手动检查更新，或直接通过 [GitHub Release 页面](https://github.com/Reedo0910/ColorLift/releases) 下载最新的版本。

5. **关于在 Windows / macOS 下窗口渲染异常**

在测试阶段观察到拾彩可能在 Windows 或 macOS 下遇到窗口渲染异常问题。具体表现为在调整应用窗口大小、或是当系统切换深/浅色主题时，窗口背景颜色的透明度会发生异常变化。目前可通过重启应用恢复。

6. **关于取色精确度**

由于本应用的取色原理为获取屏幕的截屏上的单个像素点色值，浏览器网页测试基本与实际色值吻合，但不排除在某些极端情况下，取色结果与实际颜色会产生有丝微偏移。该偏移对色彩描述的影响可忽略不计，但不推荐将拾彩作为专业数码测色计使用。

7. **关于更多的功能 / 语言模型 / 设置项支持**

我想让该应用功能和设置尽可能精简。在保持应用简单易用的原则上，暂不打算添加例如区域取色、保存取色历史等的其他复杂功能，或是其他语言模型的支持（除非某个模型相比现今应用支持的所有模型都具有非常显著优势）。

因为本人精力所限，本项目将维持在可用的基础上提供基本的 BUG 修复、已有的模型版本更新与安全支持。

## 鸣谢

本项目离不开以下的开源项目：

[Electron](https://www.electronjs.org/) | [fast-average-color-node](https://github.com/fast-average-color/fast-average-color-node) | [screenshot-desktop](https://github.com/bencevans/screenshot-desktop) | [sharp](https://sharp.pixelplumbing.com/) | [simplebar](https://github.com/Grsmto/simplebar) | [electron-store](https://github.com/sindresorhus/electron-store) | [i18next](https://www.i18next.com/)

## 许可证

[GPL-3.0 License](LICENSE)

---

拾彩的制作与设计都来自 [Zeee](https://github.com/Reedo0910)。用了很多的爱。