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