Giter VIP home page Giter VIP logo

invitarr's Introduction

Discord DockerHub Docker Pulls

Invitarr

Invitarr is a chatbot that invites discord users to plex. You can also automate this bot to invite discord users to plex once a certain role is given to a user or the user can also be added manually.

Features

  • Ability to invite users to plex from discord
  • Fully automatic invites using roles
  • Ability to kick users from plex if they leave the discord server or if their role is taken away.
  • Ability to view the database in discord and to edit it.
  • Fully configurable via a web portal

Commands:

.plexinvite <email>
This command is used to add an email to plex
.plexremove <email>
This command is used to remove an email from plex
.dbls
This command is used to list Invitarrs database
.dbadd <email> <@user>
This command is used to add exsisting users email and discord id to the DB.
.dbrm <position>
This command is used to remove a record from the Db. Use -db ls to determine record position. ex: -db rm 1

Unraid Installation

  1. Ensure you have the Community Applications plugin installed.
  2. Inside the Community Applications app store, search for Invitarr.
  3. Click the Install Button.
  4. On the following Add Container screen, add discord bot token.
  5. Click apply
  6. Finish setting up using Setup Commands

Setup

1. Enter discord bot token in bot.env

2. Install requirements

pip3 install -r requirements.txt 

3. Start the bot

python3 Run.py

Docker Setup & Start

  1. First pull the image
docker pull piratify/invitarr:latest
  1. Make the container
docker run -d --restart unless-stopped --name invitarr -v /path to config:/app/app/config -e "token=YOUR_DISCORD_TOKEN_HERE" piratify/invitarr:latest

After bot has started

Setup Commands:

.setupplex
This command is used to setup plex login. 
.roleadd <@role>
These role(s) will be used as the role(s) to automatically invite user to plex
.setuplibs (optional)
This command is used to setup plex libraries. Default is set to all. 

Refer to the Wiki for detailed steps.

Enable Intents else bot will not Dm users after they get the role. https://discordpy.readthedocs.io/en/latest/intents.html#privileged-intents

invitarr's People

Contributors

fabsau avatar faizyy01 avatar ttury avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.