Editor: Allow to override CLI args on a per-instance basis #57975

mhilbrunner · 2022-02-11T15:04:07Z

When running the Project from the Editor, this allows the user to override the CLI arguments each instance is started with per instance using the new advanced project settings editor/run/instance_1_run_args through editor/run/instance_4_run_args (overriding editor/run/main_run_args for each instance if set).

This is useful for multiplayer testing or when testing with different settings/profiles to reduce manual configuration on each test/run.

These new advanced settings, like the main run args one, are hidden by default.
Supersedes #57910. May also be a first step towards this proposal: godotengine/godot-proposals#522

When running the Project from the Editor, this allows the user to override the CLI arguments each instance is started with per instance using the new project settings editor/run/instance_1_run_args through editor/run/instance_4_run_args (overriding editor/run/main_run_args for each instance if set). This is useful for multiplayer testing or when testing with different settings/profiles to reduce manual configuration on each test/run.

mhilbrunner · 2022-02-11T15:22:52Z

Some thoughts on the current implementation:

This overrides the main args setting. Some in the proposal suggested these being additional, i.e. being added to the main args for that instance. This comes with two problems:
1. Overriding an arg given in the main args for a single instance would be difficult. You now need to either define it for all instances and remove it from main, or we need to implement matching/replacement logic.
2. Due to the %command% handling we support, this would be brittle and complex code, unless we decided you can only provide additional args per instance, not make use of %command%. That seems bad, because e.g. having some instances run with optimus, or in different environments for testing seems useful.
These are currently Project Settings like the main args one. I can see the argument given in the proposal for these not being stored as Project Settings, but only locally, so they aren't committed to VCS etc. Open for suggestions where to store them instead.
1. However, them being Project Settings does come with some niceties: docs, tooltips (online and googleable, so easy to discover!), and them being right under the main args setting, which, again, improves discoverability. Maybe it would be nice to have a way to override Project Settings locally.

Faless

See my comments, I think these options should be project metadata in EditorSettings, and not stored in project settings.

Maybe it's time we add some form of "run configuration" page like many IDEs do? I'm not great at UX so I'm a bit unsure what a good simple design would be here.

Faless · 2022-02-16T17:28:12Z

editor/editor_run.cpp


-	const String raw_custom_args = ProjectSettings::get_singleton()->get("editor/run/main_run_args");
+void EditorRun::parse_run_args(String *exec_path, List<String> *args, const String raw_custom_args) {


This fits more the godot codebase:

Suggested change

void EditorRun::parse_run_args(String *exec_path, List<String> *args, const String raw_custom_args) {

void EditorRun::parse_run_args(String &r_exec_path, List<String> &r_args, const String p_raw_custom_args) {

Faless · 2022-02-16T17:35:05Z

editor/editor_run.cpp

+		String instance_arg_setting = "editor/run/instance_" + itos(instance_num) + "_run_args";
+		String raw_custom_args = ProjectSettings::get_singleton()->get(instance_arg_setting);


I feel like these should be in editor settings meta too (i.e. EditorSettings::get_singleton()->get_project_metadata("debug_options", instance_arg_setting)).

We don't really want to export them, they are debug/editor configurations, not something to store in the project settings.

I guess that raises the question of where to show those info, and maybe an hint to proceed towards an initial implementation of godotengine/godot-proposals#522 ?

bruvzg

Any reason to limit it to the 4 instances?

Note: I have not tested suggested changes, but PackedStringArray project setting should work fine.

*Edit: * Ah, I see, it's already limited to 4 instances (took me a few minutes to find it).
But it's probably better to add instances_to_run as another project setting (or just use size of the argument list as an instance number), the current UI is not intuitive.

bruvzg · 2022-02-22T12:35:42Z

core/config/project_settings.cpp

+	GLOBAL_DEF("editor/run/instance_1_run_args", "");
+	GLOBAL_DEF("editor/run/instance_2_run_args", "");
+	GLOBAL_DEF("editor/run/instance_3_run_args", "");
+	GLOBAL_DEF("editor/run/instance_4_run_args", "");


Suggested change

GLOBAL_DEF("editor/run/instance_1_run_args", "");

GLOBAL_DEF("editor/run/instance_2_run_args", "");

GLOBAL_DEF("editor/run/instance_3_run_args", "");

GLOBAL_DEF("editor/run/instance_4_run_args", "");

GLOBAL_DEF("editor/run/instance_run_args", PackedStringArray());

bruvzg · 2022-02-22T12:36:25Z

editor/editor_run.cpp

@@ -184,9 +184,44 @@ Error EditorRun::run(const String &p_scene) {
 		args.push_back(p_scene);
 	}

-	String exec = OS::get_singleton()->get_executable_path();
+	int instances = EditorSettings::get_singleton()->get_project_metadata("debug_options", "run_debug_instances", 1);


Suggested change

int instances = EditorSettings::get_singleton()->get_project_metadata("debug_options", "run_debug_instances", 1);

int instances = EditorSettings::get_singleton()->get_project_metadata("debug_options", "run_debug_instances", 1);

PackedStringArray instance_arg_setting = ProjectSettings::get_singleton()->get("editor/run/instance_run_args");

bruvzg · 2022-02-22T12:37:20Z

editor/editor_run.cpp

+		String instance_arg_setting = "editor/run/instance_" + itos(instance_num) + "_run_args";
+		String raw_custom_args = ProjectSettings::get_singleton()->get(instance_arg_setting);


Suggested change

String instance_arg_setting = "editor/run/instance_" + itos(instance_num) + "_run_args";

String raw_custom_args = ProjectSettings::get_singleton()->get(instance_arg_setting);

String raw_custom_args;

if (instance_num >= instance_arg_setting.size()) {

raw_custom_args = instance_arg_setting[instance_num - 1];

}

Faless · 2022-02-22T13:07:25Z

@bruvzg as mentioned above, I don't think these should be project settings at all.
They are not meaningful during export, only for the editor debug, so it should go in the EditorSettings project metadata.
Instances to run are limited to 4 because it's set from the debug menu -> run multiple instance in the editor and we decided to hardcode it at the time, so it has to be adjusted there too in case:

godot/editor/plugins/debugger_editor_plugin.cpp

Lines 101 to 110 in 33c7f52

    
           instances_menu->add_radio_check_item(TTR("Run 1 Instance")); 
        
           instances_menu->set_item_metadata(0, 1); 
        
           instances_menu->add_radio_check_item(TTR("Run 2 Instances")); 
        
           instances_menu->set_item_metadata(1, 2); 
        
           instances_menu->add_radio_check_item(TTR("Run 3 Instances")); 
        
           instances_menu->set_item_metadata(2, 3); 
        
           instances_menu->add_radio_check_item(TTR("Run 4 Instances")); 
        
           instances_menu->set_item_metadata(3, 4); 
        
           instances_menu->set_item_checked(0, true); 
        
           instances_menu->connect("index_pressed", callable_mp(this, &DebuggerEditorPlugin::_select_run_count));

godot/editor/plugins/debugger_editor_plugin.cpp

Lines 119 to 125 in 33c7f52

    
           void DebuggerEditorPlugin::_select_run_count(int p_index) { 
        
           	int len = instances_menu->get_item_count(); 
        
           	for (int idx = 0; idx < len; idx++) { 
        
           		instances_menu->set_item_checked(idx, idx == p_index); 
        
           	} 
        
           	EditorSettings::get_singleton()->set_project_metadata("debug_options", "run_debug_instances", instances_menu->get_item_metadata(p_index)); 
        
           }

akien-mga · 2022-02-22T13:09:31Z

We discussed this on #editor and I propose making the configuration of these multiple instances a full featured dialog where the number of instances and their arguments can be configured. Quick and dirty mockup:

As @groud pointed it out this could use a Tree like e.g. the AutoLoad settings dialog. This was just to illustrate the feature set, UX should still be worked on.

I'll comment further in the proposal, it's probably best to keep things there.
Edit: Done: godotengine/godot-proposals#522 (comment)

cyraid · 2023-10-04T18:53:21Z

@Faless If it were Editor Settings, then how would I specify -id 1 to one Project, and -someotherarg in a different one? It would have to be project settings.

@bruvzg I like it! I was hoping for such a change. Would someone be able to add this in?

Faless · 2023-10-05T12:42:09Z

@Faless If it were Editor Settings, then how would I specify -id 1 to one Project, and -someotherarg in a different one? It would have to be project settings.

EditorSettings project metadata are per project, so no, it doesn't have to be project settings.

See: https://docs.godotengine.org/en/stable/classes/class_editorsettings.html#class-editorsettings-method-set-project-metadata

cyraid · 2023-10-07T22:16:15Z

@Faless Okeys. Would you be able to review #57975 or commit this one? ^_^ (since I have you here lol)

mhilbrunner · 2024-06-29T23:34:52Z

Closing, as I currently lack the bandwidth for this one. Still should be done however IMO :)

mhilbrunner added enhancement topic:editor labels Feb 11, 2022

mhilbrunner added this to the 4.0 milestone Feb 11, 2022

mhilbrunner requested review from a team as code owners February 11, 2022 15:04

mhilbrunner requested review from Faless and removed request for a team February 11, 2022 15:04

mhilbrunner changed the title ~~Allow to override CLI args on a per-instance basis~~ Editor: Allow to override CLI args on a per-instance basis Feb 11, 2022

mhilbrunner mentioned this pull request Feb 11, 2022

Add --run-instance=<num> when run from editor #57910

Closed

Faless requested changes Feb 16, 2022

View reviewed changes

bruvzg reviewed Feb 22, 2022

View reviewed changes

akien-mga mentioned this pull request Feb 22, 2022

Allow to specify command-line arguments when running project instances from the editor godotengine/godot-proposals#522

Closed

Faless mentioned this pull request Jul 3, 2022

Add debug instance index argument when running multiple instances #62656

Closed

YuriSizov mentioned this pull request Feb 4, 2023

Separate cmd args per debug instance godotengine/godot-proposals#6232

Closed

YuriSizov modified the milestones: 4.0, 4.1 Feb 4, 2023

YuriSizov added the needs work label Feb 4, 2023

YuriSizov modified the milestones: 4.1, 4.2 Jun 14, 2023

This comment was marked as off-topic.

Sign in to view

AThousandShips modified the milestones: 4.2, 4.3 Oct 26, 2023

mhilbrunner closed this Jun 29, 2024

mhilbrunner removed this from the 4.3 milestone Jun 29, 2024

mhilbrunner added salvageable and removed needs work labels Jun 29, 2024

AThousandShips added the archived label Jun 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editor: Allow to override CLI args on a per-instance basis #57975

Editor: Allow to override CLI args on a per-instance basis #57975

mhilbrunner commented Feb 11, 2022 •

edited

Loading

mhilbrunner commented Feb 11, 2022 •

edited

Loading

Faless left a comment

Faless Feb 16, 2022

Faless Feb 16, 2022

bruvzg left a comment •

edited

Loading

bruvzg Feb 22, 2022

bruvzg Feb 22, 2022

bruvzg Feb 22, 2022

Faless commented Feb 22, 2022

akien-mga commented Feb 22, 2022 •

edited

Loading

This comment was marked as off-topic.

cyraid commented Oct 4, 2023

Faless commented Oct 5, 2023 •

edited

Loading

cyraid commented Oct 7, 2023 •

edited

Loading

mhilbrunner commented Jun 29, 2024


		const String raw_custom_args = ProjectSettings::get_singleton()->get("editor/run/main_run_args");
		void EditorRun::parse_run_args(String exec_path, List<String> args, const String raw_custom_args) {

	void EditorRun::parse_run_args(String exec_path, List<String> args, const String raw_custom_args) {
	void EditorRun::parse_run_args(String &r_exec_path, List<String> &r_args, const String p_raw_custom_args) {

		String instance_arg_setting = "editor/run/instance_" + itos(instance_num) + "_run_args";
		String raw_custom_args = ProjectSettings::get_singleton()->get(instance_arg_setting);

	int instances = EditorSettings::get_singleton()->get_project_metadata("debug_options", "run_debug_instances", 1);
	int instances = EditorSettings::get_singleton()->get_project_metadata("debug_options", "run_debug_instances", 1);
	PackedStringArray instance_arg_setting = ProjectSettings::get_singleton()->get("editor/run/instance_run_args");

-		String instance_arg_setting = "editor/run/instance_" + itos(instance_num) + "_run_args";
-		String raw_custom_args = ProjectSettings::get_singleton()->get(instance_arg_setting);
+		String raw_custom_args;
+		if (instance_num >= instance_arg_setting.size()) {
+			raw_custom_args = instance_arg_setting[instance_num - 1];
+		}

Editor: Allow to override CLI args on a per-instance basis #57975

Editor: Allow to override CLI args on a per-instance basis #57975

Conversation

mhilbrunner commented Feb 11, 2022 • edited Loading

mhilbrunner commented Feb 11, 2022 • edited Loading

Faless left a comment

Choose a reason for hiding this comment

Faless Feb 16, 2022

Choose a reason for hiding this comment

Faless Feb 16, 2022

Choose a reason for hiding this comment

bruvzg left a comment • edited Loading

Choose a reason for hiding this comment

bruvzg Feb 22, 2022

Choose a reason for hiding this comment

bruvzg Feb 22, 2022

Choose a reason for hiding this comment

bruvzg Feb 22, 2022

Choose a reason for hiding this comment

Faless commented Feb 22, 2022

akien-mga commented Feb 22, 2022 • edited Loading

This comment was marked as off-topic.

cyraid commented Oct 4, 2023

Faless commented Oct 5, 2023 • edited Loading

cyraid commented Oct 7, 2023 • edited Loading

mhilbrunner commented Jun 29, 2024

mhilbrunner commented Feb 11, 2022 •

edited

Loading

mhilbrunner commented Feb 11, 2022 •

edited

Loading

bruvzg left a comment •

edited

Loading

akien-mga commented Feb 22, 2022 •

edited

Loading

Faless commented Oct 5, 2023 •

edited

Loading

cyraid commented Oct 7, 2023 •

edited

Loading