theme.md

   1 ## Available themes
   2 #### Default
   3 ![Default](./screenshot/themes/Default.png)
   4 #### Monokai
   5 ![Monokai](./screenshot/themes/Monokai.png)
   6 #### Solarized
   7 ![Solarized](./screenshot/themes/Solarized.png)
   8 #### Tomorrow Night
   9 ![Solarized](./screenshot/themes/TomorrowNight.png)
  10 #### Larapaste
  11 ![Solarized](./screenshot/themes/larapaste.png)
  12
  13 ## Customization
  14 Create a file `~/.rainbow_config.json` and follow next instruction.
  15
  16 Examples are available in
  17 [Themes folder](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset)
  18
  19 ### Custom config
  20  * Config file's name should be exactly `.rainbow_config.json` and placed at home directory.
  21  * Config file's content should follow json format.
  22  * Comments as `//` or `/*...*/` are allowed.
  23  * Here is an example
  24
  25 ```json
  26 {
  27     "DECORATED_NAME" : "term_198",
  28     "CYCLE_COLOR" :["term_198","term_57","term_166","term_50","term_179","term_74","term_112"],
  29     "TWEET" : {
  30         "nick"      : "term_112",
  31         "clock"     : "term_57",
  32         "id"        : "term_166",
  33         "favourite" : "term_50",
  34         "rt"        : "term_179",
  35         "link"      : "term_74",
  36         "keyword"   : "on_light_green"
  37     },
  38
  39     "MESSAGE" : {
  40         "sender"    : "term_112",
  41         "recipient" : "term_112",
  42         "to"        : "term_50",
  43         "clock"     : "term_57",
  44         "id"        : "term_166"
  45     },
  46
  47     "PROFILE" : {
  48         "statuses_count"    : "term_112",
  49         "friends_count"     : "term_198",
  50         "followers_count"   : "term_57",
  51         "nick"              : "term_198",
  52         "profile_image_url" : "term_74",
  53         "description"       : "term_166",
  54         "location"          : "term_112",
  55         "url"               : "term_74",
  56         "clock"             : "term_57"
  57     },
  58
  59     "TREND" : {
  60         "url": "term_74"
  61     },
  62
  63     "CAL" : {
  64         "days": "term_57",
  65         "today": "on_light_blue"
  66     }
  67 }
  68 ```
  69
  70 ### Available Colors
  71
  72 There 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
  90 These colors will be enough for almost terminals.
  91 But if your terminal can support 256 colors (check your `$TERM` variable!),
  92 you can even use `term_0` to `term_255` as the example above.
  93
  94 There 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
 113 Color reference can be found at
 114 [bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or
 115 [256 xterm colors](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html).
 116
 117 ### Available options
 118 * `DECORATED_NAME`: color of your Twitter's __username__ which is placed at every line's begin.
 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_.
 121   * It's means that same names will appear in same colors.
 122 * `TWEET`: colors of parts in a tweet's ouput.
 123   * `nick` : color for Twitter __username__.
 124   * `clock`: color for time of tweet.
 125   * `id`: color for tweet's id
 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
 129   * `keyword`: color for highlighted keyword (in tweets search)
 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:
 147   * `url`: color for trend's url.
 148 * `CAL`: colors for calendar's output:
 149   * `days`: color for days in current month
 150   * `today`: color for today.
 151
 152 ### Theme usage
 153 While 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
 159 I appreciate any contribution for themes for this app.
 160 Please 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.