Update theme.md
[rainbowstream.git] / theme.md
CommitLineData
53c6dfc7 1## Available themes
b84845b9
O
2#### Default
3![Default](./screenshot/themes/Default.png)
4#### Monokai
5![Monokai](./screenshot/themes/Monokai.png)
6#### Solarized
7![Solarized](./screenshot/themes/Solarized.png)
8
9## Customize:
10You are free to create your own themes.
53c6dfc7
O
11
12Create a file `~/.rainbow_config.json` and follow next instruction.
0c989606 13
53c6dfc7
O
14Examples are available in
15[Monokai theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/monokai.json)
b84845b9 16or
53c6dfc7
O
17[Solarized theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/solarized.json)
18
19### Custom config
20 * Config file should be excatly named `.rainbow_config.json` and placed at home directory.
21 * Config file's content should follow `Json` format.
22 * Comment as `//` or `/*...*/` is accepted.
23 * Here is an example
24
25```json
26 /* Color config
27 There are 16 basic colors supported :
28 * default
29 * black
30 * red
31 * green
32 * yellow
33 * blue
34 * magenta
35 * cyan
36 * grey
37 * light_red
38 * light_green
39 * light_yellow
40 * light_blue
41 * light_magenta
42 * light_cyan
43 * white
44 and 256 terminal's colors from term_0 to term_255
45 */
46
47 "DECORATED_NAME" : "term_198",
48 "CYCLE_COLOR" :["term_198","term_57","term_166","term_50","term_179","term_74","term_112"],
49 "TWEET" : {
50 "nick" : "term_112",
51 "clock" : "term_57",
52 "id" : "term_166",
53 "favourite" : "term_50",
54 "rt" : "term_179",
55 "link" : "term_74",
56 "keyword" : "on_light_green"
57 },
58
59 "MESSAGE" : {
60 "sender" : "term_112",
61 "recipient" : "term_112",
62 "to" : "term_50",
63 "clock" : "term_57",
64 "id" : "term_166"
65 },
66
67 "PROFILE" : {
68 "statuses_count" : "term_112",
69 "friends_count" : "term_198",
70 "followers_count" : "term_57",
71 "nick" : "term_198",
72 "profile_image_url" : "term_74",
73 "description" : "term_166",
74 "location" : "term_112",
75 "url" : "term_74",
76 "clock" : "term_57"
77 },
78
79 "TREND" : {
80 "url": "term_74"
81 }
82}
83```
84
85### Available Colors
86
87There are 16 basic colors:
88 * default
89 * black
90 * red
91 * green
92 * yellow
93 * blue
94 * magenta
95 * cyan
96 * grey
97 * light_red
98 * light_green
99 * light_yellow
100 * light_blue
101 * light_magenta
102 * light_cyan
103 * white
104
105These colors will be enough for almost terminals.
d646f0dd 106But if your terminals can support 256 colors (check your `$TERM` variable!),
53c6dfc7
O
107you can even use `term_0` to `term_255` as sample above.
108
109Color reference can be found at
110[bash color](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or
111[256 xterm](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html)
112
113### Available options
0c989606
O
114* `DECORATED_NAME`: color of your Twitter's __username__ which is placed at every line's begin.
115* `CYCLE_COLOR`: list of colors from which Twitter __real name__ 's color is selected.
116 * Color selection is cycle through this list but with a _memoization_.
117 * It's means that same names will appear in same colors.
118* `TWEET`: colors of various part in a tweet's ouput.
119 * `nick` : color for Twitter __username__.
120 * `clock`: color for time of tweet.
121 * `id`: color for Tweet's id
122 * `favorite`: color for the star symbol when a tweet is favorited by you
123 * `rt`: color for `RT` word in tweet's content.
124 * `link`: color for an url
125 * `keyword`: color for highlighted keyword (in tweets search)
126* `MESSAGE`: colors of parts in message's output.
127 * `sender`: color for sender's __username__.
128 * `recipient`: color for recipient's __username__.
129 * `to`: color for the `>>>` symbol.
130 * `clock`: color for time of message.
131 * `id`: color for message's id
132* `PROFILE`: colors for parts in profile's ouput.
133 * `statuses_count`: color for statuses count.
134 * `friends_count`: color for friends count.
135 * `followers_count`: color for followers count.
136 * `nick`: color for Twitter __username__.
137 * `profile_image_url`: color for profile image url.
138 * `description`: color for description.
139 * `location`: color for location.
140 * `url`: color for url.
141 * `clock`: color for joined time.
142* `TREND`: colors for trend's output:
143 * `url`: color for url.
b84845b9 144