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