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