text-to-colorscheme  by svermeulen

Neovim plugin for generating colorschemes from text prompts using OpenAI

Created 3 years ago
317 stars

Top 85.1% on SourcePulse

GitHubView on GitHub
Project Summary

This Neovim plugin generates custom color schemes from text prompts using OpenAI's GPT API. It's designed for Neovim users who want to easily create unique, personalized editor aesthetics without manual color definition, offering a dynamic alternative to static color schemes.

How It Works

The plugin leverages OpenAI's GPT API to interpret a user-provided text prompt and translate it into a color palette suitable for Neovim. It then applies this palette to the editor's highlight groups. The approach allows for creative, natural language-driven color scheme generation, moving beyond predefined palettes.

Quick Start & Requirements

  • Installation: use { "svermeulen/text-to-colorscheme.nvim" } (packer.nvim)
  • Prerequisites: Neovim 0.8.0+, OpenAI API key (optional, for generation).
  • Setup: Configure openai_api_key in require('text-to-colorscheme').setup().
  • Usage: Set colorscheme with vim.cmd([[colorscheme text-to-colorscheme]]), generate with :T2CGenerate <prompt>.
  • Docs: README

Highlighted Details

  • Generates color schemes via text prompts using OpenAI's GPT API.
  • Supports dynamic theme selection and saving generated palettes.
  • Includes commands for tweaking contrast, saturation, and accent shuffling.
  • Offers advanced configuration for AI parameters, built-in schemes, and highlight group overrides.

Maintenance & Community

The project is actively maintained by svermeulen. Further community interaction details are not explicitly provided in the README.

Licensing & Compatibility

The project is licensed under the MIT License, permitting commercial use and integration with closed-source projects.

Limitations & Caveats

The plugin currently only supports dark themes. The quality of generated schemes is dependent on the OpenAI API and the descriptiveness of the text prompt. Generated themes may require manual tweaking for optimal results.

Health Check
Last Commit

1 year ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
0 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.