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