Skip to content

Commit 0300c77

Browse files
HaveAGitGatHaveAGitGat
committed
Update README.md
1 parent bf6995a commit 0300c77

File tree

1 file changed

+38
-23
lines changed

1 file changed

+38
-23
lines changed

‎README.md‎

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,19 @@ Audio/Video Library Analytics & Transcode/Remux Automation
1717

1818

1919
<h2>About:</h2>
20+
More information can be found on the following websites:
2021

21-
Tdarr V2 is a closed-source distributed transcoding system for automating media library transcode/remux management and making sure your files are exactly how you need them to be in terms of codecs/streams/containers and so on. Put your spare hardware to use with Tdarr Nodes for Windows, Linux (including Linux arm) and macOS.
22+
[https://tdarr.io/](https://tdarr.io/)
23+
[https://docs.tdarr.io/](https://docs.tdarr.io/)
24+
25+
Tdarr V2 is a cross-platform conditional based transcoding application for automating media library transcode/remux management in order to process your media files as required. For example, you can set rules for the required codecs, containers, languages etc that your media should have which helps keeps things organized and can increase compatability with your devices. A common use for Tdarr is to simply convert video files from h264 to h265 (hevc), saving 40%-50% in size.
26+
27+
The application is in the form of a click-to-run web-app, comprised of the following 2 components:
28+
29+
Tdarr_Server - Central process which all Nodes connect with
30+
Tdarr_Node - Processes running on same/other devices which collect tasks from the Server
31+
32+
Put your spare hardware to use with Tdarr Nodes for Windows, Linux (including Linux arm/arm64) and macOS.
2233

2334
Designed to work alongside applications like Sonarr/Radarr and built with the aim of modularisation, parallelisation and scalability, each library you add has its own transcode settings, filters and schedule. Workers can be fired up and closed down as necessary, and are split into 4 types - Transcode CPU/GPU and Health Check CPU/GPU. Worker limits can be managed by the scheduler as well as manually. For a desktop application with similar functionality please see [HBBatchBeast](https://github.com/HaveAGitGat/HBBatchBeast).
2435

@@ -43,19 +54,32 @@ https://github.com/HaveAGitGat/Tdarr_Plugins
4354
<img src="https://i.imgur.com/wRV6tBJ.png" height="300" />
4455
</p>
4556

46-
---------------------------------------------------------------------------------------
47-
## Transcode management
48-
![Screenshot](https://storage.googleapis.com/tdarr/media/images/Nodes.PNG)
4957
---------------------------------------------------------------------------------------
5058
## Stats
51-
![Screenshot](https://storage.googleapis.com/tdarr/media/images/Stats2.PNG)
59+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/Stats2.png)
60+
---------------------------------------------------------------------------------------
61+
## Nodes
62+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/Nodes.png)
63+
---------------------------------------------------------------------------------------
64+
## Job reports
65+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/JobReportViewer.png)
66+
---------------------------------------------------------------------------------------
67+
## Property explorer
68+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/SizeExplorer.png)
69+
---------------------------------------------------------------------------------------
70+
## Worker verdict history
71+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/VerdictHistory.png)
72+
---------------------------------------------------------------------------------------
73+
## Plugin stack system
74+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/Plugins2.png)
75+
---------------------------------------------------------------------------------------
76+
## Property search
77+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/Search2.png)
5278
---------------------------------------------------------------------------------------
53-
## Search
54-
![Screenshot](https://storage.googleapis.com/tdarr/media/images/Search2.PNG)
79+
## Library schedule
80+
![Screenshot](https://tdarrs.s3.us-west-000.backblazeb2.com/data/images2/home_pics/Schedule.png)
5581
---------------------------------------------------------------------------------------
56-
## Plugins
57-
![Screenshot](https://storage.googleapis.com/tdarr/media/images/Plugins2.PNG)
58-
-------------------------------------------------------------------------------------------------------------
82+
5983

6084
Tdarr is extremely modular/configurable and the main idea behind it is creating a plugin stack to clean up/standardise your files. For example, a typical plugin stack might look like this:
6185

@@ -90,10 +114,10 @@ https://i.imgur.com/RaKnq2c.png
90114
That file has 3 streams - a video, audio and subtitle stream. Subtitles and closed captions are very different. Where is the closed caption data in this example? It's embedded inside the h264 video stream.
91115

92116

93-
Extra streams and closed captions which you don't need can cause problems with direct playing and syncing files, so you might as well remove them (I recommend using Bazarr for subtitles). Even when playing files in programs such as VLC or Kodi, subtitles/closed captions can cause playback delays and make things stuttery for a few seconds when jumping around the video.
117+
Extra streams and closed captions which you don't need can cause problems with direct playing and syncing files, so you might as well remove them (it's recommended to use something like Bazarr for subtitles). Even when playing files in programs such as VLC or Kodi, subtitles/closed captions can cause playback delays and make things stuttery for a few seconds when jumping around the video.
94118

95119

96-
Extra streams can also take up a lot of space. Don't be surprised to see some files in your library with 15+ audio/commentary/subtitle tracks in a bunch of different languages . These can take up an extra GB+ per file.
120+
Extra streams can also take up a lot of space. Don't be surprised to see some files in your library with 15+ audio/commentary/subtitle tracks in a bunch of different languages. These can take up an extra GB+ per file.
97121

98122

99123
The plugin creator is split into 'Filters' and 'Actions'. Filters encapsulate the actions, so the actions will only be carried out if the filter conditions are met.
@@ -136,7 +160,7 @@ Some of the actions have become quite complicated so take a bit more time. For e
136160
If you have a request for a new filter/action, then try and think of it generically so I can implement it in way that other people can configure and apply it to their (slightly) different circumstances. Request on GitHub,Reddit or Discord.
137161

138162

139-
I like to maximise the chance of direct play, so my plugin stack looks like this:
163+
For example, to maximize direct play, a plugin stack like this can be used:
140164

141165

142166
(1) If not in h264, transcode into h264 [h264 is a more universal video codec than others]
@@ -149,13 +173,4 @@ I like to maximise the chance of direct play, so my plugin stack looks like this
149173

150174
(5) Add aac stereo audio if none (eng preferred) [very universal audio codec/channel count]
151175

152-
(6) Remove meta-data if title meta detected [Stops annoying titles appearing in Plex]
153-
154-
155-
156-
157-
158-
159-
160-
161-
176+
(6) Remove meta-data if title meta detected [Stops annoying titles appearing in Plex]

0 commit comments

Comments
 (0)