# lctv-bot-youtube-plugin

> YouTube plugin for the LCTV Bot

Latest version **1.0.0** (published 2015-11-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install lctv-bot-youtube-plugin
pnpm add lctv-bot-youtube-plugin
yarn add lctv-bot-youtube-plugin
bun add lctv-bot-youtube-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-11-03 |
| First published | 2015-11-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Owen Conti |
| Maintainers | ohseemedia |

## Links

- npm: https://www.npmjs.com/package/lctv-bot-youtube-plugin
- npm.io page: https://npm.io/package/lctv-bot-youtube-plugin

## Dependencies (1)

- [youtube-node](https://npm.io/package/youtube-node.md) ^1.3.0

## Recent versions

- 1.0.0 (latest) — 2015-11-03

## README

# Setup

You must create an app under in the YouTube Developer portal.  (https://console.developers.google.com/start)[https://console.developers.google.com/start]

Create a settings.json file in the root plugin directory with the following structure:

```
{
	"youtubeApiKey" : "YOUTUBE_API_KEY",
	"requiredVotesToSkip" : 3
}
```

# Commands

Once you've setup the `settings.json` file, make sure you have the client app running.
To run the new client app:
  * Make sure the bot is running
  * Open a new terminal window and navigate to `/client`
  * Run `python -m SimpleHTTPServer {PORT}`
  * Navgiate to `localhost:{PORT}/#{USERNAME}`
  * The websocket connection should happen, any plugin code should be loaded, and then the client page should be ready to go.

Once the client app is running, you can use the following commands:

* !play - Starts the player
* !pause - Pauses the player
* !skip - As a moderator: Skips the track (currently random)
* !skip - As a viewer: Places a vote to skip the track. The number of votes required is defined in the `requiredVotesToSkip` setting
* !request {YOUTUBE_VIDEO_ID} - Adds the request YouTube video to the playlist

---
_Source: https://npm.io/package/lctv-bot-youtube-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
