https://github.com/haveagitgat/tdarr_plugins

Tdarr Plugins
https://github.com/haveagitgat/tdarr_plugins

Last synced: 2 days ago
JSON representation

Tdarr Plugins

• Host: GitHub
• URL: https://github.com/haveagitgat/tdarr_plugins
• Owner: HaveAGitGat
• License: gpl-3.0
• Created: 2019-09-22T19:13:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T22:31:43.000Z (3 months ago)
• Last Synced: 2024-12-24T07:13:04.382Z (10 days ago)
• Language: JavaScript
• Homepage:
• Size: 4.17 MB
• Stars: 142
• Watchers: 6
• Forks: 169
• Open Issues: 148
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Tdarr_Plugins

Visit the docs for more info:

https://docs.tdarr.io/docs/plugins/basics

### Development

Make sure NodeJS v16 is installed

Install dependencies:

`npm install`

Run ESLint:

`npm run lint:fix`

Check plugins using some extra custom rules:

`npm run checkPlugins`

Run tests:

`npm run test`

# Steps to write a Tdarr Flow plugin:

1. Clone this repo

2. Set env variable `pluginsDir` to the location of the plugins repo and run Tdarr Server and Node. E.g. `export pluginsDir=C:/Tdarr_Plugins`

3. Browse the typescript plugins here https://github.com/HaveAGitGat/Tdarr_Plugins/tree/master/FlowPluginsTs/CommunityFlowPlugins and make edits locally or create a new one locally: 

4. Make sure typescript is intalled with `npm i -g typescript` then run `tsc` to compile the changes.

5. Refresh the browser and Tdarr will pick up the changes