delete unused break
[rainbowstream.git] / theme.md
CommitLineData
53c6dfc7 1## Available themes
b84845b9
O
2#### Monokai
3![Monokai](./screenshot/themes/Monokai.png)
4#### Solarized
5![Solarized](./screenshot/themes/Solarized.png)
4ad5dc07
O
6#### Tomorrow Night
7![Solarized](./screenshot/themes/TomorrowNight.png)
8#### Larapaste
9![Solarized](./screenshot/themes/larapaste.png)
b84845b9 10
0af9ed49 11## Customization
df7a8b6f 12Modify `~/.rainbow_config.json` and follow next instruction.
0c989606 13
831d3164 14Examples are available in
4ad5dc07 15[Themes folder](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset)
53c6dfc7
O
16
17### Custom config
df7a8b6f
O
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.
d4dcaeb7 20 * Comments as `//` or `/*...*/` are allowed.
53c6dfc7
O
21 * Here is an example
22
23```json
bd97b07c 24{
fa6e062d
O
25 "DECORATED_NAME" : 198,
26 "CYCLE_COLOR" :[198,57,166,50,179,74,112],
53c6dfc7 27 "TWEET" : {
ff1a4e5f
O
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"
53c6dfc7
O
38 },
39
40 "MESSAGE" : {
ff1a4e5f
O
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
53c6dfc7
O
50 },
51
52 "PROFILE" : {
fa6e062d
O
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
53c6dfc7
O
62 },
63
64 "TREND" : {
fa6e062d 65 "url": 74
271ea6a1 66 },
fa6e062d 67
271ea6a1 68 "CAL" : {
fa6e062d 69 "days": 57,
271ea6a1 70 "today": "on_light_blue"
ff1a4e5f
O
71 },
72
73 "GROUP" : {
74 "name": 112,
75 "member": 57,
76 "subscriber": 198,
77 "mode": 112,
78 "description": 166,
79 "clock": 57
53c6dfc7
O
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.
831d3164 105But if your terminal can support 256 colors (check your `$TERM` variable!),
fa6e062d 106you can even use 0 to 255 as the example above.
53c6dfc7 107
271ea6a1
O
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
831d3164
O
127Color reference can be found at
128[bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or
be0fa7c7 129[256 xterm colors](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html).
53c6dfc7
O
130
131### Available options
0c989606 132* `DECORATED_NAME`: color of your Twitter's __username__ which is placed at every line's begin.
831d3164
O
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_.
0c989606 135 * It's means that same names will appear in same colors.
d4dcaeb7 136* `TWEET`: colors of parts in a tweet's ouput.
571ea706
O
137 * `mynick` : color for your Twitter __username__.
138 * `nick` : color for other Twitter __username__.
0c989606 139 * `clock`: color for time of tweet.
ff1a4e5f
O
140 * `id`: color for tweet's id.
141 * `favorite`: color for the star symbol when a tweet is favorited by you.
142 * `retweet_count`: color for retweets count.
143 * `favorite_count`: color for favorites count.
0c989606 144 * `rt`: color for `RT` word in tweet's content.
ff1a4e5f
O
145 * `link`: color for an url.
146 * `hashtag`: color for a hashtag.
37cf396a 147 * `mytweet`: color for tweet's text from yourself.
ff1a4e5f 148 * `keyword`: color for highlighted keyword (in tweets search).
0c989606 149* `MESSAGE`: colors of parts in message's output.
ff1a4e5f
O
150 * `partner`: color for __partner__.
151 * `me`: color for __authenticated user__.
152 * `partner_frame`: color for __partner's frame__.
153 * `me_frame`: color for __authenticated user's frame__.
0c989606
O
154 * `sender`: color for sender's __username__.
155 * `recipient`: color for recipient's __username__.
156 * `to`: color for the `>>>` symbol.
157 * `clock`: color for time of message.
ff1a4e5f 158 * `id`: color for message's id.
0c989606
O
159* `PROFILE`: colors for parts in profile's ouput.
160 * `statuses_count`: color for statuses count.
161 * `friends_count`: color for friends count.
162 * `followers_count`: color for followers count.
163 * `nick`: color for Twitter __username__.
164 * `profile_image_url`: color for profile image url.
165 * `description`: color for description.
166 * `location`: color for location.
167 * `url`: color for url.
168 * `clock`: color for joined time.
169* `TREND`: colors for trend's output:
d4dcaeb7 170 * `url`: color for trend's url.
271ea6a1 171* `CAL`: colors for calendar's output:
ff1a4e5f 172 * `days`: color for days in current month.
271ea6a1 173 * `today`: color for today.
ff1a4e5f
O
174* `GROUP`: colors for twitter list output:
175 * `name`: color for twitter list's name.
176 * `member`: color member count.
177 * `subscriber`: color subscriber count.
178 * `mode`: color twitter list's mode.
179 * `description`: color twitter list's description.
180 * `clock`: color twitter list's created time.
b84845b9 181
8cffb56b
O
182### Theme usage
183While entered Rainbow Stream:
184* `theme` and hit ENTER to see which is available.
185* `theme` + TAB twice will show themes list instantly.
186* `theme monokai` will apply `monokai` theme immediately. You can use TAB key for theme's name autocompletion.
187
188### Theme contribution
0af9ed49 189I appreciate any contribution for themes for this app.
8cffb56b
O
190Please add a file to [themes folder](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream/colorset)
191(json format!) and create a [pull request](https://github.com/DTVD/rainbowstream/compare/) with a screenshot.