From f9e39ee4be045c26161bf40da6daa55df587fa97 Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Mon, 16 Jun 2025 07:43:51 -0400 Subject: [PATCH] Further clarify configuration requirements for CLI (fixes #861) --- CHANGELIST.md | 1 + MPF.CLI/Program.cs | 13 +++++++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/CHANGELIST.md b/CHANGELIST.md index 7286dbda..fc474e4a 100644 --- a/CHANGELIST.md +++ b/CHANGELIST.md @@ -1,6 +1,7 @@ ### WIP (xxxx-xx-xx) - Handle layers for PS3CFW +- Further clarify configuration requirements for CLI ### 3.3.2 (2025-06-12) diff --git a/MPF.CLI/Program.cs b/MPF.CLI/Program.cs index 94f81332..e95275ff 100644 --- a/MPF.CLI/Program.cs +++ b/MPF.CLI/Program.cs @@ -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 Override default dumping program"); + Console.WriteLine("-u, --use Override configured dumping program name"); Console.WriteLine("-d, --device Physical drive path (Required if no custom parameters set)"); Console.WriteLine("-m, --mounted Mounted filesystem path for additional checks"); Console.WriteLine("-f, --file \"\" Output file path (Required if no custom parameters set)"); @@ -214,6 +214,11 @@ namespace MPF.CLI Console.WriteLine("-c, --custom \"\" 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.");