Further clarify configuration requirements for CLI (fixes #861)

This commit is contained in:
Matt Nadareski
2025-06-16 07:43:51 -04:00
parent 0a4621c963
commit f9e39ee4be
2 changed files with 10 additions and 4 deletions

View File

@@ -1,6 +1,7 @@
### WIP (xxxx-xx-xx)
- Handle layers for PS3CFW
- Further clarify configuration requirements for CLI
### 3.3.2 (2025-06-12)

View File

@@ -91,7 +91,7 @@ namespace MPF.CLI
case InternalProgram.Aaru:
if (!File.Exists(options.AaruPath))
{
DisplayHelp("A path needs to be supplied for Aaru, exiting...");
DisplayHelp("A path needs to be supplied in config.json for Aaru, exiting...");
return;
}
break;
@@ -99,7 +99,7 @@ namespace MPF.CLI
case InternalProgram.DiscImageCreator:
if (!File.Exists(options.DiscImageCreatorPath))
{
DisplayHelp("A path needs to be supplied for DIC, exiting...");
DisplayHelp("A path needs to be supplied in config.json for DIC, exiting...");
return;
}
break;
@@ -107,7 +107,7 @@ namespace MPF.CLI
case InternalProgram.Redumper:
if (!File.Exists(options.RedumperPath))
{
DisplayHelp("A path needs to be supplied for Redumper, exiting...");
DisplayHelp("A path needs to be supplied in config.json for Redumper, exiting...");
return;
}
break;
@@ -206,7 +206,7 @@ namespace MPF.CLI
Console.WriteLine();
Console.WriteLine("CLI Options:");
Console.WriteLine("-u, --use <program> Override default dumping program");
Console.WriteLine("-u, --use <program> Override configured dumping program name");
Console.WriteLine("-d, --device <devicepath> Physical drive path (Required if no custom parameters set)");
Console.WriteLine("-m, --mounted <dirpath> Mounted filesystem path for additional checks");
Console.WriteLine("-f, --file \"<filepath>\" Output file path (Required if no custom parameters set)");
@@ -214,6 +214,11 @@ namespace MPF.CLI
Console.WriteLine("-c, --custom \"<params>\" Custom parameters to use");
Console.WriteLine();
Console.WriteLine("Dumping program paths and other settings can be found in the config.json file");
Console.WriteLine("generated next to the program by default. Ensure that all settings are to user");
Console.WriteLine("preference before running MPF.CLI.");
Console.WriteLine();
Console.WriteLine("Custom dumping parameters, if used, will fully replace the default parameters.");
Console.WriteLine("All dumping parameters need to be supplied if doing this.");
Console.WriteLine("Otherwise, both a drive path and output file path are required.");