62 lines
2.0 KiB
Org Mode
62 lines
2.0 KiB
Org Mode
#+title: ytplay.el
|
||
#+author: Lucien Cartier-Tilet
|
||
#+email: lucien@phundrak.com
|
||
* Introduction
|
||
~ytplay.el~ is a utility for playing YouTube videos (mainly, not tested
|
||
with other websites) from Emacs in an external video player.
|
||
|
||
This package is geared towards Linux users in particular, but PR for
|
||
adding support for other operating systems are welcome!
|
||
|
||
* Table of Contents :TOC_2_gh:
|
||
- [[#introduction][Introduction]]
|
||
- [[#installation][Installation]]
|
||
- [[#customizing][Customizing]]
|
||
- [[#contributing][Contributing]]
|
||
- [[#license][License]]
|
||
|
||
* Installation
|
||
A couple of options are available for installing ~ytplay.el~. The first
|
||
one is to clone the repository in your ~load-path~ and add the following
|
||
to your ~.emacs~ or your ~init.el~:
|
||
#+begin_src emacs-lisp
|
||
(require 'ytplay)
|
||
#+end_src
|
||
|
||
In my case, I prefer using ~use-package~ with ~straight~:
|
||
#+begin_src emacs-lisp
|
||
(use-package ytplay
|
||
:ensure t
|
||
:defer t
|
||
:straight (ytplay :type git
|
||
:host nil
|
||
:repo "https://labs.phundrak.com/phundrak/ytplay.el"))
|
||
#+end_src
|
||
|
||
I personally also added ~:build t~ in the straight recipe to ensure
|
||
Emacs compiles my package, both to ~.elc~ and ~.eln~ files (I am on Emacs
|
||
28.0, ~feature/native-comp~ got merged into ~master~!)
|
||
|
||
There is probably a similar way to install it with pure ~straight.el~ or
|
||
~quelpa~, but I’m not knowledgable enough for that, feel free to create
|
||
a PR to add some more installation instructions!
|
||
|
||
There is currently no plans of making this package available on MELPA
|
||
or non-gnu elpa.
|
||
|
||
* Customizing
|
||
For now, only one variable can be edited by the user in order to
|
||
configure ~ytplay.el~:
|
||
- ~ytplay-video-player~ :: Executable name of your video player. It can
|
||
be either its name if it is present on your ~$PATH~, or a path to the
|
||
executable.
|
||
|
||
Default value: ~"mpv"~
|
||
|
||
* Contributing
|
||
See [[file:CONTRIBUTING.org]].
|
||
|
||
* License
|
||
~ytplay.el~ is available under the GNU GPL-3.0 license. You can find the
|
||
full text in [[file:LICENSE.md][LICENSE.md]].
|