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         "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"
  38     },
  39
  40     "MESSAGE" : {
  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
  50     },
  51
  52     "PROFILE" : {
  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
  62     },
  63
  64     "TREND" : {
  65         "url": 74
  66     },
  67
  68     "CAL" : {
  69         "days": 57,
  70         "today": "on_light_blue"
  71     },
  72
  73     "GROUP" : {
  74         "name": 112,
  75         "member": 57,
  76         "subscriber": 198,
  77         "mode": 112,
  78         "description": 166,
  79         "clock": 57
  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.
 105 But if your terminal can support 256 colors (check your `$TERM` variable!),
 106 you can even use 0 to 255 as the example above.
 107
 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
 127 Color reference can be found at
 128 [bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or
 129 [256 xterm colors](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html).
 130
 131 ### Available options
 132 * `DECORATED_NAME`: color of your Twitter's __username__ which is placed at every line's begin.
 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_.
 135   * It's means that same names will appear in same colors.
 136 * `TWEET`: colors of parts in a tweet's ouput.
 137   * `mynick` : color for your Twitter __username__.
 138   * `nick` : color for other Twitter __username__.
 139   * `clock`: color for time of tweet.
 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.
 144   * `rt`: color for `RT` word in tweet's content.
 145   * `link`: color for an url.
 146   * `hashtag`: color for a hashtag.
 147   * `mytweet`: color for tweet's text from yourself.
 148   * `keyword`: color for highlighted keyword (in tweets search).
 149 * `MESSAGE`: colors of parts in message's output.
 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__.
 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.
 158   * `id`: color for message's id.
 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:
 170   * `url`: color for trend's url.
 171 * `CAL`: colors for calendar's output:
 172   * `days`: color for days in current month.
 173   * `today`: color for today.
 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.
 181
 182 ### Theme usage
 183 While 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
 189 I appreciate any contribution for themes for this app.
 190 Please 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.