Commit | Line | Data |
---|---|---|
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 | 12 | Modify `~/.rainbow_config.json` and follow next instruction. |
0c989606 | 13 | |
831d3164 | 14 | Examples 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 | ||
86 | There 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 | ||
104 | These colors will be enough for almost terminals. | |
831d3164 | 105 | But if your terminal can support 256 colors (check your `$TERM` variable!), |
fa6e062d | 106 | you can even use 0 to 255 as the example above. |
53c6dfc7 | 107 | |
271ea6a1 O |
108 | There 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 |
127 | Color 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. |
0c989606 O |
137 | * `nick` : color for Twitter __username__. |
138 | * `clock`: color for time of tweet. | |
ff1a4e5f O |
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. | |
0c989606 | 143 | * `rt`: color for `RT` word in tweet's content. |
ff1a4e5f O |
144 | * `link`: color for an url. |
145 | * `hashtag`: color for a hashtag. | |
146 | * `keyword`: color for highlighted keyword (in tweets search). | |
0c989606 | 147 | * `MESSAGE`: colors of parts in message's output. |
ff1a4e5f O |
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__. | |
0c989606 O |
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. | |
ff1a4e5f | 156 | * `id`: color for message's id. |
0c989606 O |
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: | |
d4dcaeb7 | 168 | * `url`: color for trend's url. |
271ea6a1 | 169 | * `CAL`: colors for calendar's output: |
ff1a4e5f | 170 | * `days`: color for days in current month. |
271ea6a1 | 171 | * `today`: color for today. |
ff1a4e5f O |
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. | |
b84845b9 | 179 | |
8cffb56b O |
180 | ### Theme usage |
181 | While 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 | |
0af9ed49 | 187 | I appreciate any contribution for themes for this app. |
8cffb56b O |
188 | Please 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. |