add notification command
[rainbowstream.git] / theme.md
1 ## Available themes
2 #### Monokai
3 ![Monokai](./screenshot/themes/Monokai.png)
4 #### Solarized
5 ![Solarized](./screenshot/themes/Solarized.png)
6 #### Tomorrow Night
7 ![Solarized](./screenshot/themes/TomorrowNight.png)
8 #### Larapaste
9 ![Solarized](./screenshot/themes/larapaste.png)
10
11 ## Customization
12 Modify `~/.rainbow_config.json` and follow next instruction.
13
14 Examples are available in
15 [Themes folder](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset)
16
17 ### Custom config
18  * There is a file named exactly `.rainbow_config.json` and is placed at your home directory.
19  * Add color configurations to above file and follow json format.
20  * Comments as `//` or `/*...*/` are allowed.
21  * Here is an example
22
23 ```json
24 {
25     "DECORATED_NAME" : 198,
26     "CYCLE_COLOR" :[198,57,166,50,179,74,112],
27     "TWEET" : {
28         "nick"            : 112,
29         "clock"           : 57,
30         "id"              : 166,
31         "favorited"       : 50,
32         "retweet_count"   : 50,
33         "favorite_count"  : 198,
34         "rt"              : 179,
35         "link"            : 74,
36         "hashtag"         : 198,
37         "keyword"         : "on_light_green"
38     },
39
40     "NOTIFICATION":{
41         "source_nick"   : 112,
42         "notify"        : 179,
43         "clock"         : 57
44     },
45
46     "MESSAGE" : {
47         "partner"       : 112,
48         "me"            : 112,
49         "me_frame"      : 74,
50         "partner_frame" : 198,
51         "sender"        : 112,
52         "recipient"     : 112,
53         "to"            : 50,
54         "clock"         : 57,
55         "id"            : 166
56     },
57
58     "PROFILE" : {
59         "statuses_count"    : 112,
60         "friends_count"     : 198,
61         "followers_count"   : 57,
62         "nick"              : 198,
63         "profile_image_url" : 74,
64         "description"       : 166,
65         "location"          : 112,
66         "url"               : 74,
67         "clock"             : 57
68     },
69
70     "TREND" : {
71         "url": 74
72     },
73
74     "CAL" : {
75         "days": 57,
76         "today": "on_light_blue"
77     },
78
79     "GROUP" : {
80         "name": 112,
81         "member": 57,
82         "subscriber": 198,
83         "mode": 112,
84         "description": 166,
85         "clock": 57
86     }
87 }
88 ```
89
90 ### Available Colors
91
92 There are 16 basic colors:
93   * default
94   * black
95   * red
96   * green
97   * yellow
98   * blue
99   * magenta
100   * cyan
101   * grey
102   * light_red
103   * light_green
104   * light_yellow
105   * light_blue
106   * light_magenta
107   * light_cyan
108   * white
109
110 These colors will be enough for almost terminals.
111 But if your terminal can support 256 colors (check your `$TERM` variable!),
112 you can even use 0 to 255 as the example above.
113
114 There are also background highlight colors like:
115   * on_default
116   * on_black
117   * on_red
118   * on_green
119   * on_yellow
120   * on_blue
121   * on_magenta
122   * on_cyan
123   * on_grey
124   * on_light_red
125   * on_light_green
126   * on_light_yellow
127   * on_light_blue
128   * on_light_magenta
129   * on_light_cyan
130   * on_white
131
132
133 Color reference can be found at
134 [bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or
135 [256 xterm colors](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html).
136
137 ### Available options
138 * `DECORATED_NAME`: color of your Twitter's __username__ which is placed at every line's begin.
139 * `CYCLE_COLOR`: list of colors from which Twitter __real name__ 's color is selected.
140   * Color selection is cycle through this list but with _memoization_.
141   * It's means that same names will appear in same colors.
142 * `TWEET`: colors of parts in a tweet's ouput.
143   * `mynick` : color for your Twitter __username__.
144   * `nick` : color for other Twitter __username__.
145   * `clock`: color for time of tweet.
146   * `id`: color for tweet's id.
147   * `favorite`: color for the star symbol when a tweet is favorited by you.
148   * `retweet_count`: color for retweets count.
149   * `favorite_count`: color for favorites count.
150   * `rt`: color for `RT` word in tweet's content.
151   * `link`: color for an url.
152   * `hashtag`: color for a hashtag.
153   * `mytweet`: color for tweet's text from yourself.
154   * `keyword`: color for highlighted keyword (in tweets search).
155 * `NOTIFICATION`: colors of notification events.
156   * `source_nick`: color for user's __username__.
157   * `notify`: color for notification message.
158   * `clock`: color for time of notification event.
159 * `MESSAGE`: colors of parts in message's output.
160   * `partner`: color for __partner__.
161   * `me`: color for __authenticated user__.
162   * `partner_frame`: color for __partner's frame__.
163   * `me_frame`: color for __authenticated user's frame__.
164   * `sender`: color for sender's __username__.
165   * `recipient`: color for recipient's __username__.
166   * `to`: color for the `>>>` symbol.
167   * `clock`: color for time of message.
168   * `id`: color for message's id.
169 * `PROFILE`: colors for parts in profile's ouput.
170   * `statuses_count`: color for statuses count.
171   * `friends_count`: color for friends count.
172   * `followers_count`: color for followers count.
173   * `nick`: color for Twitter __username__.
174   * `profile_image_url`: color for profile image url.
175   * `description`: color for description.
176   * `location`: color for location.
177   * `url`: color for url.
178   * `clock`: color for joined time.
179 * `TREND`: colors for trend's output:
180   * `url`: color for trend's url.
181 * `CAL`: colors for calendar's output:
182   * `days`: color for days in current month.
183   * `today`: color for today.
184 * `GROUP`: colors for twitter list output:
185   * `name`: color for twitter list's name.
186   * `member`: color member count.
187   * `subscriber`: color subscriber count.
188   * `mode`: color twitter list's mode.
189   * `description`: color twitter list's description.
190   * `clock`: color twitter list's created time.
191
192 ### Theme usage
193 While entered Rainbow Stream:
194 * `theme` and hit ENTER to see which is available.
195 * `theme` + TAB twice will show themes list instantly.
196 * `theme monokai` will apply `monokai` theme immediately. You can use TAB key for theme's name autocompletion.
197
198 ### Theme contribution
199 I appreciate any contribution for themes for this app.
200 Please add a file to [themes folder](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream/colorset)
201 (json format!) and create a [pull request](https://github.com/DTVD/rainbowstream/compare/) with a screenshot.