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