gabehf
/
Tdarr_Plugins
mirror of https://github.com/gabehf/Tdarr_Plugins.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1587 Commits
3 Branches
0 Tags
4.8 MiB
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Go to file
HaveAGitGat 6cfc352f56
docs: update with notes on .git folder handling 		9 months ago
.github Use windows-2022 1 year ago
Community style: use capitals in plugin name 10 months ago
FlowPlugins Apply auto-build changes 9 months ago
FlowPluginsTs feat: use onSelect handler instead 9 months ago
examples Format classic plugin names 2 years ago
methods Fix spacing 2 years ago
tests test: update macos tests 10 months ago
.eslintrc.json Update ts lint rules 2 years ago
.gitattributes Use lf 2 years ago
.gitignore Update .gitignore 2 years ago
LICENSE Initial commit 6 years ago
README.md docs: update with notes on .git folder handling 9 months ago
package-lock.json Add eslint_d 2 years ago
package.json Add eslint_d 2 years ago
tsconfig.eslint.json Update community plugin lint rules, add ts 2 years ago
tsconfig.json Update community plugin lint rules, add ts 2 years ago

README.md

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

Note, pluginsDir directories that contain a .git folder (such as when cloning this repo) will cause Tdarr to skip plugin updates to prevent overwriting development changes.