gabehf/Tdarr_Plugins
1
0
Fork 0
mirror of https://github.com/gabehf/Tdarr_Plugins.git synced 2026-03-07 21:48:15 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
1587 commits 3 branches 0 tags 4.8 MiB
Find a file
Exact
HaveAGitGat 6cfc352f56 docs: update with notes on .git folder handling
2025-03-05 17:07:32 +00:00
.github Use windows-2022 2024-07-08 13:29:54 +01:00
Community style: use capitals in plugin name 2025-02-22 14:42:02 +00:00
examples Format classic plugin names 2024-05-21 15:10:09 +01:00
FlowPlugins Apply auto-build changes 2025-03-02 17:51:42 +00:00
FlowPluginsTs feat: use onSelect handler instead 2025-03-02 17:50:04 +00:00
methods Fix spacing 2023-11-27 05:39:42 +00:00
tests test: update macos tests 2025-02-22 14:56:52 +00:00
.eslintrc.json Update ts lint rules 2023-08-20 17:25:04 +01:00
.gitattributes Use lf 2023-11-13 08:07:27 +00:00
.gitignore Update .gitignore 2023-09-28 17:42:20 +01:00
LICENSE Initial commit 2019-09-22 20:13:53 +01:00
package-lock.json Add eslint_d 2023-08-29 07:00:52 +01:00
package.json Add eslint_d 2023-08-29 07:00:52 +01:00
README.md docs: update with notes on .git folder handling 2025-03-05 17:07:32 +00:00
tsconfig.eslint.json Update community plugin lint rules, add ts 2023-08-20 17:29:04 +01:00
tsconfig.json Update community plugin lint rules, add ts 2023-08-20 17:29:04 +01:00

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.