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