theme.md

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