Mercurial > vim

annotate runtime/colors/README.txt @ 28862:82244cfc4694

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update runtime files, new color schemes Commit: https://github.com/vim/vim/commit/30ab04e16e1e9e6133590181197b3f8e70cb495e Author: Bram Moolenaar <Bram@vim.org> Date: Sat May 14 13:33:50 2022 +0100 Update runtime files, new color schemes
author Bram Moolenaar <Bram@vim.org>
date Sat, 14 May 2022 14:45:04 +0200
parents 92c424550367
children 57c9377b9c62
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 README.txt for color scheme files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 These files are used for the ":colorscheme" command. They appear in the
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
4 "Edit/Color Scheme" menu in the GUI.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 Hints for writing a color scheme file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 There are two basic ways to define a color scheme:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 1. Define a new Normal color and set the 'background' option accordingly.
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
12
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 set background={light or dark}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 highlight clear
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 highlight Normal ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 2. Use the default Normal color and automatically adjust to the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 'background'.
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
20
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 highlight clear Normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 set background&
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 highlight clear
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 if &background == "light"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 highlight Error ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 highlight Error ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 You can use ":highlight clear" to reset everything to the defaults, and then
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
33 change the groups that you want differently. This will also work for groups
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 that are added in later versions of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 Note that ":highlight clear" uses the value of 'background', thus set it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 before this command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 Some attributes (e.g., bold) might be set in the defaults that you want
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 removed in your color scheme. Use something like "gui=NONE" to remove the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 attributes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 1622
diff changeset
41 In case you want to set 'background' depending on the colorscheme selected,
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 1622
diff changeset
42 this autocmd might be useful:
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
43
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 1622
diff changeset
44 autocmd SourcePre */colors/blue_sky.vim set background=dark
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
45
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 1622
diff changeset
46 Replace "blue_sky" with the name of the colorscheme.
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 1622
diff changeset
47
10319
169a62d5bcb9 commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents: 5555
diff changeset
48 In case you want to tweak a colorscheme after it was loaded, check out the
13810
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
49 ColorScheme autocommand event.
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
50
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
51 To clean up just before loading another colorscheme, use the ColorSchemePre
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
52 autocommand event. For example:
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
53
13810
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
54 let g:term_ansi_colors = ...
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
55 augroup MyColorscheme
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
56 au!
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
57 au ColorSchemePre * unlet g:term_ansi_colors
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
58 au ColorSchemePre * au! MyColorscheme
cad480bac9e1 patch 8.0.1777: cannot cleanup before loading another colorscheme
Christian Brabandt <cb@256bit.org>
parents: 13049
diff changeset
59 augroup END
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 1622
diff changeset
60
10319
169a62d5bcb9 commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents: 5555
diff changeset
61 To customize a colorscheme use another name, e.g. "~/.vim/colors/mine.vim",
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
62 and use ":runtime" to load the original colorscheme:
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
63
10319
169a62d5bcb9 commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents: 5555
diff changeset
64 " load the "evening" colorscheme
169a62d5bcb9 commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents: 5555
diff changeset
65 runtime colors/evening.vim
169a62d5bcb9 commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents: 5555
diff changeset
66 " change the color of statements
169a62d5bcb9 commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents: 5555
diff changeset
67 hi Statement ctermfg=Blue guifg=Blue
169a62d5bcb9 commit https://github.com/vim/vim/commit/b4ada79aa7d0d1e5da3a659b1a203d7cae9f7f59
Christian Brabandt <cb@256bit.org>
parents: 5555
diff changeset
68
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
69 To see which highlight group is used where, see ":help highlight-groups" and
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
70 ":help group-name".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 You can use ":highlight" to find out the current colors. Exception: the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 ctermfg and ctermbg values are numbers, which are only valid for the current
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
74 terminal. Use the color names instead for better portability. See
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
75 ":help cterm-colors".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
77 The default color settings can be found in the source file src/syntax.c.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 Search for "highlight_init".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 If you think you have a color scheme that is good enough to be used by others,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 please check the following items:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82
13857
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13810
diff changeset
83 - Source the $VIMRUNTIME/colors/tools/check_colors.vim script to check for
e751b5c9dff3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13810
diff changeset
84 common mistakes.
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
85
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
86 - Does it work in a color terminal as well as in the GUI? Is it consistent?
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
87
1622
149d8b46404c updated for version 7.2a
vimboss
parents: 7
diff changeset
88 - Is "g:colors_name" set to a meaningful value? In case of doubt you can do
149d8b46404c updated for version 7.2a
vimboss
parents: 7
diff changeset
89 it this way:
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
90
1622
149d8b46404c updated for version 7.2a
vimboss
parents: 7
diff changeset
91 let g:colors_name = expand('<sfile>:t:r')
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
92
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 - Is 'background' either used or appropriately set to "light" or "dark"?
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
94
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 - Try setting 'hlsearch' and searching for a pattern, is the match easy to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 spot?
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
97
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 - Split a window with ":split" and ":vsplit". Are the status lines and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 vertical separators clearly visible?
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
100
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 - In the GUI, is it easy to find the cursor, also in a file with lots of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 syntax highlighting?
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
103
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
104 - In general, test your color scheme against as many filetypes, Vim features,
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
105 environments, etc. as possible.
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
106
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 - Do not use hard coded escape sequences, these will not work in other
28862
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
108 terminals. Always use #RRGGBB for the GUI.
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
109
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
110 - When targetting 8-16 colors terminals, don't count on "darkblue" to be blue
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
111 and dark, or on "2" to be even vaguely reddish. Names are more portable
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
112 than numbers, though.
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
113
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
114 - When targetting 256 colors terminals, prefer colors 16-255 to colors 0-15
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
115 for the same reason.
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
116
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
117 - Typographic attributes (bold, italic, underline, reverse, etc.) are not
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
118 universally supported. Don't count on any of them.
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
119
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
120 - Is "g:terminal_ansi_colors" set to a list of 16 #RRGGBB values?
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
121
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
122 - Try to keep your color scheme simple by avoiding unnecessary logic and
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
123 refraining from adding options. The best color scheme is one that only
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
124 requires:
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
125
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
126 colorscheme foobar
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
127
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
128 The color schemes distributed with Vim are built with lifepillar/colortemplate
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
129 (https://github.com/lifepillar/vim-colortemplate). It is therefore highly
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
130 recommended.
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
131
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
132 If you would like your color scheme to be distributed with Vim, make sure
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
133 that:
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
134
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
135 - it satisfies the guidelines above,
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
136 - it was made with colortemplate,
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
137
82244cfc4694 Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents: 26057
diff changeset
138 and join us at vim/colorschemes: (https://github.com/vim/colorschemes).