gigidsss/Plex-Bot-Music
1
0
Fork 0
mirror of https://github.com/jarulsamy/Plex-Bot.git synced 2024-08-19 15:01:55 +02:00
Code Issues Projects Releases Wiki Activity

📝 Format fixes

Browse Source
This commit is contained in:
Joshua Arulsamy 2020-08-09 20:12:31 -06:00
parent 33bbf21bab
commit 4aadd886d5
1 changed files with 59 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -3,7 +3,7 @@
[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html) [![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html)
![docker pulls](https://img.shields.io/docker/pulls/jarulsamy/plex-bot) ![docker pulls](https://img.shields.io/docker/pulls/jarulsamy/plex-bot)
![docker img size](https://img.shields.io/docker/image-size/jarulsamy/plex-bot) ![docker img size](https://img.shields.io/docker/image-size/jarulsamy/plex-bot)
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> ![black badge](https://img.shields.io/badge/code%20style-black-000000.svg)
A Python-based Plex music bot for discord. A Python-based Plex music bot for discord.
@ -15,9 +15,9 @@ Plex-Bot runs entirely in a Docker container. Ensure you have Docker and docker-
1. Create a new folder and `cd` into it: 1. Create a new folder and `cd` into it:
``` ```bash
$ mkdir Plex-Bot mkdir Plex-Bot
$ cd Plex-Bot cd Plex-Bot
``` ```
2. Make a `docker-compose.yml` file or use this sample: 2. Make a `docker-compose.yml` file or use this sample:
@ -38,13 +38,12 @@ services:
restart: "unless-stopped" restart: "unless-stopped"
``` ```
3. Create a configuration folder: 3. Create a new `config` folder and create a config file like this::
Create a new `config` folder and create a config file like this: ```bash
mkdir config
``` cd config
$ mkdir config touch config.yaml
$ cd config
``` ```
```yml ```yml
@ -67,21 +66,21 @@ plex:
4. Create a Discord bot application: 4. Create a Discord bot application:
* Go to the Discord developer portal, [here](https://discord.com/developers/applications). 1. Go to the Discord developer portal, [here](https://discord.com/developers/applications).
* Log in or create an account 2. Log in or create an account
* Click New App 3. Click New App
* Fill in App Name and anything else you'd like to include 4. Fill in App Name and anything else you'd like to include
* Click Create App 5. Click Create App
This will provide you with your Client ID and Client Secret This will provide you with your Client ID and Client Secret
* Click Create Bot User 6. Click Create Bot User
This will provide you with your bot Username and Token This will provide you with your bot Username and Token
* Fill in the bot token in `config/config.yaml` 7. Fill in the bot token in `config/config.yaml`
5. Get your plex token: 5. Get your plex token:
@ -95,24 +94,24 @@ plex:
7. Start the service: 7. Start the service:
``` ```bash
$ docker-compose up -d docker-compose up -d
``` ```
## Logs ## Logs
You can view the logs with the following command You can view the logs with the following command
``` ```bash
$ docker-compose logs -f CONTAINER_NAME_OR_ID docker-compose logs -f CONTAINER_NAME_OR_ID
# For example # For example
$ docker-compose logs -f PlexBot docker-compose logs -f PlexBot
``` ```
## Usage ## Usage
``` ```text
General: General:
kill - Stop the bot. kill - Stop the bot.
Plex: Plex:
@ -129,11 +128,4 @@ Type ?help command for more info on a command.
You can also type ?help category for more info on a category. You can also type ?help category for more info on a category.
``` ```
## Support
Reach out to me at one of the following places!
- Email (Best) at joshua.gf.arul@gmail.com
- Twitter at <a href="http://twitter.com/jarulsamy_" target="_blank">`@jarulsamy_`</a>
* * * * * *