README.org

   1 * Intro
   2
   3 [[https://github.com/stardiviner/emacs-rainbow-fart/workflows/CI/badge.svg]]
   4
   5 [[logo.png]]
   6
   7 🌈 EMACS RAINBOW FART
   8
   9 This package is inspired from [[https://saekiraku.github.io/vscode-rainbow-fart/#/zh/][vscode-rainbow-fart]] and [[https://github.com/DogLooksGood/rainbow-fart.el][rainbow-fart.el]].
  10
  11 This is an interesting idea package.
  12
  13 Here is a screencast which is recorded by [[https://github.com/DogLooksGood][DogLooksGood]].
  14
  15 [[file:Emacs rainbow-fart demo.mp4][Emacs rainbow-fart demo.mp4]]
  16
  17 * Features
  18
  19 - auto play voice when you type keywords
  20 - auto play voice when you put point/cursor on flycheck error
  21 - auto play voice when in specific time quantum
  22
  23 * Install
  24
  25 ** use-package + Quelpa
  26
  27 #+begin_src emacs-lisp
  28 (use-package rainbow-fart
  29   :quelpa (rainbow-fart :fetcher "github" :repo "stardiviner/emacs-rainbow-fart")
  30   :hook (prog-mode . rainbow-fart-mode))
  31 #+end_src
  32
  33 * Usage
  34
  35 Just like the screencast video shows, A voice played when you type some keywords.
  36
  37 * Customization
  38
  39 ** choose voice model
  40
  41 #+begin_src emacs-lisp
  42 (setq rainbow-fart-voice-model "JustKowalski")
  43 #+end_src
  44
  45 *NOTE*: Currently only "JustKowalski" built-in. Contribution welcome.
  46
  47 ** control keyword voice
  48
  49 Not frequently play voice for every keywords:
  50
  51 #+begin_src emacs-lisp
  52 (setq rainbow-fart-keyword-interval (* 60 10))
  53 #+end_src
  54
  55 Play voice for every keywords:
  56
  57 #+begin_src emacs-lisp
  58 (setq rainbow-fart-keyword-interval nil)
  59 #+end_src
  60
  61 ** control hourly reminder
  62
  63 Disable hourly reminder:
  64
  65 #+begin_src emacs-lisp
  66 (setq rainbow-fart-time-interval nil)
  67 #+end_src
  68
  69 * Contribution
  70
  71 - [ ] Need an elegant solution to handle different model voices which have different voice files
  72 - [ ] Need more voice models
  73 - [ ] I will add contributors into list
  74
  75 ** Contributors
  76
  77 - DogLooksGood
  78 - lujun9972
  79
  80 * LICENSE
  81
  82 This package elisp code is published under GPL v3, the voice data is from
  83 [[https://github.com/JustKowalski][GitHub@JustKowalski]] and project [[https://github.com/SaekiRaku/vscode-rainbow-fart][vscode-rainbow-fart]] which is released under [[https://github.com/SaekiRaku/vscode-rainbow-fart/blob/master/LICENSE][MIT license]].
  84