https://github.com/hillt03/vlcyt
Stream your YouTube playlist in VLC behind the scenes from the command line.
https://github.com/hillt03/vlcyt
command-line command-line-app command-line-tool music music-bot music-information-retrieval music-library music-player pafy python python-3 python-script python3 vlc vlc-media-player vlc-player youtube youtube-api youtube-dl
Last synced: about 2 months ago
JSON representation
Stream your YouTube playlist in VLC behind the scenes from the command line.
- Host: GitHub
- URL: https://github.com/hillt03/vlcyt
- Owner: hillt03
- License: mit
- Created: 2019-12-17T05:37:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T08:54:56.000Z (almost 3 years ago)
- Last Synced: 2024-12-22T15:56:58.500Z (10 months ago)
- Topics: command-line, command-line-app, command-line-tool, music, music-bot, music-information-retrieval, music-library, music-player, pafy, python, python-3, python-script, python3, vlc, vlc-media-player, vlc-player, youtube, youtube-api, youtube-dl
- Language: Python
- Size: 76.2 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# VLCYT
Stream your YouTube playlist in VLC behind the scenes from the command line.
## Check It Out
https://streamable.com/43qzjl
## Requirements
[YouTube Data V3 API Key](https://developers.google.com/youtube/v3/getting-started)
[64-bit VLC Media Player](https://get.videolan.org/vlc/3.0.8/win64/vlc-3.0.8-win64.exe)
[64-bit Python 3.8](https://www.python.org/ftp/python/3.8.0/python-3.8.0-amd64.exe)
### Note
This project has only been tested on Windows 10.
## Installation
`pip install git+https://github.com/hillt03/VLCYT`
## Usage
Be sure to include quotes around arguments.
`python -m vlcyt ["" -a "" -v "" ]`
If you have VLC installed and get a FileNotFound Error, use the `-v` switch to include the path to your VLC install directory. Otherwise, don't forget to install VLC (64-bit). VLCYT will look for VLC in `C:\Program Files\VideoLAN\VLC` by default.
After running for the first time, you can then simply enter `python -m vlcyt` and the last playlist you passed in will begin playing.
VLCYT user data (playlist url, API key, and VLC directory) is stored in %APPDATA%\Local\VLCYT.
### Example
`python -m vlcyt "https://www.youtube.com/watch?v=8jrN6Kz2XbU&list=PLPVigFOpn3YjTdJ3-hIILmeP3jsjXntOU&index=1" -a "EXAMPLEAPIKEY" -v "C:\Program Files\VideoLAN\VLC"`
After this initial command, do the following to load your stored settings:
`python -m vlcyt`
## Commands
**NOTE:** Most commands have multiple aliases separated by commas, use whichever you prefer.
### ?, help
Opens the help menu and shows whether or not looping and shuffling are enabled.
### volume, v
Adjust the volume (0 - 100).
### skip, s, next, n, forward, f
Skips song(s).
For example: Entering "skip" will skip one song,
entering "skip 5" will skip 5 songs.
### play, pause, p
Plays/Pauses the current song.
### repeat, replay, r
Repeats the current song one time.
### back, b
Skips to the last song played.
### loop, l
Enables looping.
The current song will keep playing until looping is disabled.
### shuffle
Shuffles the playlist without repeating until every song has been played.
### copy, c, url
Copies the current song's YouTube URL.
### lyrics
EXPERIMENTAL: Attempts to retrieve the current song's lyrics.
Needs to be improved.
### exit, quit, q, x
Closes the program.
## Links
[GitHub](https://github.com/hillt03/VLCYT)
[PyPI](https://pypi.org/project/VLCYT/)