oQ.nvim

A dark and light Neovim theme written in Lua forked from the tokyonight.nvim theme.

✨ Features

• Supports the latest Neovim 0.9.0 features.
• Terminal colors.
• Provides oq extras for numerous other applications.

🎨 Supported Plugins

Plugin	Source
dashboard-nvim	dashboard
gitsigns.nvim	gitsigns
which-key.nvim	which-key

🍭 Extras

Tool	Extra
Ghostty	extras/ghostty
Kitty	extras/kitty
Vim	extras/vim
WezTerm	extras/wezterm

⚡️ Requirements

• Neovim >= 0.8.0

📦 Installation

Install the theme with your preferred package manager, such as folke/lazy.nvim:

{
  "Fro-Q/oq.nvim",
  lazy = false,
  priority = 1000,
  opts = {},
}

🚀 Usage

vim.cmd[[colorscheme oq]]
-- or specifically for one of the styles:
-- vim.cmd[[colorscheme oq-dark]] -- default
-- vim.cmd[[colorscheme oq-dark-soft]]
-- vim.cmd[[colorscheme oq-light]]
-- vim.cmd[[colorscheme oq-light-soft]]

Some plugins need extra configuration to work with oq.

Click here for more details

Lualine

-- Lua
require('lualine').setup {
  options = {
    -- ... your lualine config
    theme = 'oq'
    -- ... your lualine config
  }
}

⚙️ Configuration

Important

Set the configuration BEFORE loading the color scheme with colorscheme oq.

The theme offers four styles: dark, dark-soft, light, and light-soft.

oq uses the default options, unless setup is explicitly called.

Default Options

---@class oq.Config
---@field on_colors fun(colors: ColorScheme)
---@field on_highlights fun(highlights: oq.Highlights, colors: ColorScheme)
M.defaults = {
  style = "dark",
  light_style = "light", -- The theme is used when the background is set to light
  transparent = false, -- Enable this to disable setting the background color
  terminal_colors = true, -- Configure the colors used when opening a `:terminal` in Neovim
  styles = {
    -- Style to be applied to different syntax groups
    -- Value is any valid attr-list value for `:help nvim_set_hl`
    comments = { italic = true },
    keywords = { italic = true },
    functions = {},
    variables = {},
    -- Background styles. Can be "dark", "transparent" or "normal"
    sidebars = "dark", -- style for sidebars, see below
    floats = "dark", -- style for floating windows
  },
  day_brightness = 0.3, -- Adjusts the brightness of the colors of the **Light** style. Number between 0 and 1, from dull to vibrant colors
  dim_inactive = false, -- dims inactive windows
  lualine_bold = false, -- When `true`, section headers in the lualine theme will be bold

  --- You can override specific color groups to use other groups or a hex color
  --- function will be called with a ColorScheme table
  ---@param colors ColorScheme
  on_colors = function(colors) end,

  --- You can override specific highlights to use other groups or a hex color
  --- function will be called with a Highlights and ColorScheme table
  ---@param highlights oq.Highlights
  ---@param colors ColorScheme
  on_highlights = function(highlights, colors) end,

  cache = false, -- When set to true, the theme will be cached for better performance

  ---@type table<string, boolean|{enabled:boolean}>
  plugins = {
    -- enable all plugins when not using lazy.nvim
    -- set to false to manually enable/disable plugins
    all = package.loaded.lazy == nil,
    -- uses your plugin manager to automatically enable needed plugins
    -- currently only lazy.nvim is supported
    auto = true,
    -- add any plugins here that you want to enable
    -- for all possible plugins, see:
    --   * https://github.com/Fro-Q/oq.nvim/tree/main/lua/oq/groups
    -- telescope = true,
  },
}

🪓 Overriding Colors & Highlight Groups

How the highlight groups are calculated:

1. colors are determined based on your configuration, with the ability to override them using config.on_colors(colors).
2. These colors are utilized to generate the highlight groups.
3. config.on_highlights(highlights, colors) can be used to override highlight groups.

For default values of colors and highlights, please consult the dark, dark-soft, light, and light-soft themes.

Settings & Changing Colors

require("oq").setup({
  -- use the dark-soft style
  style = "dark-soft",
  -- disable italic for functions
  styles = {
    functions = {}
  },
  -- Change the "hint" comment color to the "coral" color, and make the "error" diagnostic color bright red
  on_colors = function(colors)
    colors.comment.hint = colors.coral
    colors.diag.error = "#ff0000"
  end
})

Fix undercurls in Tmux

To have undercurls show up and in color, add the following to your Tmux configuration file:

# Undercurl
set -g default-terminal "${TERM}"
set -as terminal-overrides ',*:Smulx=\E[4::%p1%dm'  # undercurl support
set -as terminal-overrides ',*:Setulc=\E[58::2::::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m'  # underscore colours - needs tmux-3.0

🍭 Extras

Extra color configs for Kitty, WezTerm and Ghostty can be found in extras. To use them, refer to their respective documentation.

You can easily use the color palette for other plugins inside your Neovim configuration:

local colors = require("oq.colors").setup() -- pass in any of the config options as explained above
local util = require("oq.util")

aplugin.background = colors.bg_alt
aplugin.my_error = util.lighten(colors.amber, 0.3) -- number between 0 and 1. 0 results in white, 1 results in red1

🔥 Contributing

Pull requests are welcome.

For the extras, we use a simple template system that can be used to generate themes for the different styles.

How to add a new extra template:

1. Create a file like lua/oq/extra/cool-app.lua.

2. Add the name and output file extension to the extras table in lua/oq/extra/init.lua.

3. Run the following command to generate new extra themes from the oq plugin directory:

   ./scripts/build

4. Check the newly created themes in the extra/ directory. Please DO NOT commit them, as they are already automatically built by the CI.