mirror of
https://github.com/RatzzFatzz/MKVAudioSubtitleChanger.git
synced 2026-02-11 02:05:56 +01:00
Update readme
This commit is contained in:
15
README.md
15
README.md
@@ -19,23 +19,28 @@ Attribute-config must be entered in pairs: `audio:subtitle`; Example: `jpn:eng`.
|
||||
[here](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/Attribute-Config).
|
||||
|
||||
## Available parameters
|
||||
```shell
|
||||
-l,--library <arg> Path to library
|
||||
```
|
||||
-l,--library-path <arg> Path to library
|
||||
-a,--attribute-config <arg> Attribute config to decide which tracks to choose when
|
||||
-p,--config-path <arg> Path to config file
|
||||
-m,--mkvtoolnix <arg> Path to mkv tool nix installation
|
||||
-s,--safe-mode Test run (no files will be changes)
|
||||
-c,--coherent <arg> Try to match all files in dir of depth with the same config
|
||||
-cf,--force-coherent Force coherent and don't update anything if config fits not whole config (default: false)
|
||||
-n,--only-new-files Sets filter-date to last successful execution (Overwrites input of filter-date)
|
||||
-d,--filter-date <arg> Only consider files created newer than entered date (format: "dd.MM.yyyy-HH:mm:ss")
|
||||
-t,--threads <arg> Thread count (default: 2)
|
||||
-i,--include-pattern <arg> Include files matching pattern (default: ".*")
|
||||
-e,--exclude-directories <arg> Directories to be excluded, combines with config file
|
||||
-e,--excluded-directories <arg> Directories to be excluded, combines with config file
|
||||
-fk,--forced-keywords <arg> Additional keywords to identify forced tracks
|
||||
-ck,--commentary-keywords <arg> Additional keywords to identify commentary tracks
|
||||
-ps,--preferred-subtitles <arg> Additional keywords to prefer specific subtitle tracks
|
||||
-v,--version Display version
|
||||
-h,--help "For help this is" - Yoda
|
||||
```
|
||||
If you need more information about how each parameter works, check out [this wiki page](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/Parameters).
|
||||
|
||||
All parameters can also be defined in a config file.
|
||||
Please read [this wiki page](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/How-to-config-file) for more information.
|
||||
All parameters can also be defined in a [config file](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/How-to-config-file).
|
||||
|
||||
## Build requirements
|
||||
- JDK 11 or higher
|
||||
|
||||
@@ -84,7 +84,7 @@ public class ConfigLoader {
|
||||
if (cmd == null) throw new NullPointerException();
|
||||
return cmd;
|
||||
} catch (ParseException | NullPointerException e) {
|
||||
formatter.printHelp(106, "java -jar MKVAudioSubtitlesChanger.jar -l <path_to_library>",
|
||||
formatter.printHelp(130, "java -jar MKVAudioSubtitlesChanger.jar -l <path_to_library>",
|
||||
"\nParameters:", options,
|
||||
"\nFeature requests and bug reports: https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/issues");
|
||||
System.exit(1);
|
||||
@@ -94,7 +94,7 @@ public class ConfigLoader {
|
||||
|
||||
private static void exitIfHelp(CommandLine cmd, Options options, HelpFormatter formatter) {
|
||||
if (cmd.hasOption("help")) {
|
||||
formatter.printHelp(106, "java -jar MKVAudioSubtitlesChanger.jar -l <path_to_library>",
|
||||
formatter.printHelp(130, "java -jar MKVAudioSubtitlesChanger.jar -l <path_to_library>",
|
||||
"\nParameters:", options,
|
||||
"\nFeature requests and bug reports: https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/issues");
|
||||
System.exit(0);
|
||||
|
||||
@@ -30,9 +30,8 @@ public interface FileProcessor {
|
||||
/**
|
||||
* Populate FileInfoDto with the desired tracks, based on AttributeConfig.
|
||||
* @param info to be populated
|
||||
* @param nonForcedTracks List of all not forced tracks
|
||||
* @param nonCommentaryTracks List of all not commentary tracks
|
||||
* @param configs
|
||||
* @param nonForcedTracks List of all non-forced tracks
|
||||
* @param nonCommentaryTracks List of all non-commentary tracks
|
||||
*/
|
||||
void detectDesiredTracks(FileInfoDto info, List<FileAttribute> nonForcedTracks, List<FileAttribute> nonCommentaryTracks,
|
||||
AttributeConfig... configs);
|
||||
@@ -45,7 +44,7 @@ public interface FileProcessor {
|
||||
* Update the file.
|
||||
* @param file to be updated
|
||||
* @param fileInfo information to update file
|
||||
* @throws IOException
|
||||
* @throws IOException when error occurs accessing file retrieving information
|
||||
* @throws MkvToolNixException when error occurs while sending query to mkvpropedit
|
||||
*/
|
||||
void update(File file, FileInfoDto fileInfo) throws IOException, MkvToolNixException;
|
||||
|
||||
@@ -116,7 +116,7 @@ public class ResultStatistic {
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
String sb = "ResultStatistic[" + "filesTotal=" + filesTotal +
|
||||
return "ResultStatistic[" + "filesTotal=" + filesTotal +
|
||||
", excluded=" + excluded +
|
||||
", shouldChange=" + shouldChange +
|
||||
" (failedChanging=" + failedChanging +
|
||||
@@ -126,6 +126,5 @@ public class ResultStatistic {
|
||||
", failed=" + failed +
|
||||
", runtime=" + formatTimer() +
|
||||
']';
|
||||
return sb;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user