Add --init cli argument to create new projects #25925

lupoDharkael · 2019-02-16T00:11:04Z

I works as git init but you have to pass the name of the project as an argument. I creates project.godot, icon.png and default_env.tres in the directory you call this command.

main/main.cpp

Calinou · 2019-02-16T00:50:55Z

I wonder if the directory should be created by passing --init <path to new directory> instead. This way, people don't have to cd around if they want to create several projects at once. The project name could be inferred and capitalized from the last path fragment (e.g. creating a project in /tmp/my_game would automatically call it "My Game", using the same logic as properties when they're displayed by the editor).

lupoDharkael · 2019-02-16T01:07:29Z

@Calinou yeah I though about it. The problem is the name of the folder doesn't have to be the same as the name of the project.
Maybe --init <project name> <path> and the path being an optional argument. But I don't know how could I indicate an optional argument in the --help.

bojidar-bg · 2019-02-16T08:27:03Z

Optional arguments are usually indicated using [], so --init <project name> [<path>]

lupoDharkael · 2019-02-16T11:42:15Z

Ok, I'm adding the optional path.

lupoDharkael · 2019-02-17T02:10:50Z

It is ready now.

hpvb

I think this needs some work. I don't think it's a good idea to hardcode the contents of these files. Godot already does something when saving a project for the first time, that is what it should do in this case also.

hpvb · 2019-02-18T16:00:06Z

core/project_settings.cpp

+	default_env_str += "[resource]\n";
+	default_env_str += "background_mode = 2\n";
+	default_env_str += "background_sky = SubResource( 1 )\n";
+	return default_env_str;


I don't think this is the correct approach. This means that if we change anything in the 'real' default environment we now have to change it in two places. This should serialize a normal default environment instead.

I just moved the code from project_manager.cpp as it was.
See:

godot/editor/project_manager.cpp

Lines 496 to 500 in 07498d3

f->store_line("[gd_resource type=\"Environment\" load_steps=2 format=2]");

f->store_line("[sub_resource type=\"ProceduralSky\" id=1]");

f->store_line("[resource]");

f->store_line("background_mode = 2");

f->store_line("background_sky = SubResource( 1 )");

Where can I find the default environment configuration?

I confirm that it was hard coded before, maybe default environment could be instanced and serialized to file that way?

hpvb · 2019-02-18T16:00:38Z

main/main.cpp

@@ -276,6 +276,7 @@ void Main::print_help(const char *p_binary) {
 	OS::get_singleton()->print("\n");

 	OS::get_singleton()->print("Standalone tools:\n");
+	OS::get_singleton()->print("  -i, --init <name> [<path>]       Create a new project.\n");


we already have a --path parameter. Should we reuse that instead?

That would make it more semantic.
I wonder if we should have a CLI parser to validate input and format so we can separate that from the logic based on the content. The actual code handling the cli arguments feels a bit convoluted and hardcoded.
That would make easier to have proper error handling and not opening the editor when you pass an invalid argument.

@lupoDharkael See #20000 🙂

Hmm, mixing godot -i test test and I don't really know which one is path and which one is project name, so seems logical...

To salvage the problem with whether it should create a folder by default, maybe this:
godot --init test --path (would this be empty?)

would allow to create project named test and making a directory for it, while
godot --init test --path .

would create a project inside current directory.

Or just omitting the path argument would force to create a folder named the same as project:
godot --init test

I agree that the --init command should not take an optional path argument.
It should also not default to creating a folder, unless the path given does not exist, in which .ase it should try to create it.

So:

// Create "test" project in current working directory godot --init test // Create "test" project in previously created "myfolder" directory mkdir myfolder godot --init test --path myfolder // Create "test" project in myother/folder subdirectory, creating them as needed godot --init test --path myother/folder

Xrayez · 2019-04-21T18:43:46Z

I tried this:
godot --init test test --editor

Expected to run editor after init, but nothing happens. Of course it would make more sense with --path argument:

godot --init test --path . --editor # create in current dir, name project as "test", run editor
godot --init test --editor # mkdir "test" automatically, name project as "test", run editor

lupoDharkael · 2019-04-21T23:51:00Z

I'm waiting for #26213 to be reviewed and tested before I continue with this PR

akien-mga · 2019-05-29T14:01:36Z

main/main.cpp

@@ -276,6 +276,7 @@ void Main::print_help(const char *p_binary) {
 	OS::get_singleton()->print("\n");

 	OS::get_singleton()->print("Standalone tools:\n");
+	OS::get_singleton()->print("  -i, --init <name> [<path>]       Create a new project.\n");


This should be within #ifdef TOOLS_ENABLED (and same for the parsing of -i and --init).

akien-mga · 2019-10-30T12:07:34Z

Moving to the next milestone as this PR still needs some work.

aaronfranke · 2020-06-17T01:02:32Z

Since this PR depends on #26213, I will close this for now. It can be re-opened or re-created later.

lupoDharkael requested a review from reduz as a code owner February 16, 2019 00:11

YeldhamDev reviewed Feb 16, 2019

View reviewed changes

main/main.cpp Outdated Show resolved Hide resolved

Calinou added enhancement topic:editor labels Feb 16, 2019

YeldhamDev approved these changes Feb 16, 2019

View reviewed changes

lupoDharkael force-pushed the init branch from b934fa0 to 0391edb Compare February 16, 2019 01:17

akien-mga added this to the 3.2 milestone Feb 16, 2019

lupoDharkael force-pushed the init branch from 0391edb to 1cf431a Compare February 17, 2019 02:08

Add --init cli argument to create new projects

845afd8

lupoDharkael force-pushed the init branch from 1cf431a to 845afd8 Compare February 17, 2019 02:11

hpvb requested changes Feb 18, 2019

View reviewed changes

akien-mga removed the request for review from reduz April 30, 2019 12:44

akien-mga reviewed May 29, 2019

View reviewed changes

Calinou mentioned this pull request Sep 16, 2019

godot init like git init or let Godot build projects in existing dirs. godotengine/godot-proposals#78

Open

akien-mga modified the milestones: 3.2, 4.0 Oct 30, 2019

aaronfranke added the needs work label May 26, 2020

aaronfranke marked this pull request as draft May 26, 2020 15:01

rcorre mentioned this pull request Jun 1, 2020

Allow creating project in a nonempty directory. #39220

Closed

aaronfranke closed this Jun 17, 2020

aaronfranke added the archived label Jun 17, 2020

aaronfranke added the salvageable label Jun 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --init cli argument to create new projects #25925

Add --init cli argument to create new projects #25925

lupoDharkael commented Feb 16, 2019

Calinou commented Feb 16, 2019 •

edited

Loading

lupoDharkael commented Feb 16, 2019

bojidar-bg commented Feb 16, 2019

lupoDharkael commented Feb 16, 2019

lupoDharkael commented Feb 17, 2019

hpvb left a comment

hpvb Feb 18, 2019

lupoDharkael Feb 18, 2019

Xrayez Apr 21, 2019

hpvb Feb 18, 2019

lupoDharkael Feb 18, 2019

Calinou Feb 18, 2019 •

edited

Loading

Xrayez Apr 21, 2019

akien-mga May 29, 2019

Xrayez commented Apr 21, 2019

lupoDharkael commented Apr 21, 2019

akien-mga May 29, 2019

akien-mga commented Oct 30, 2019

aaronfranke commented Jun 17, 2020

	f->store_line("[gd_resource type=\"Environment\" load_steps=2 format=2]");
	f->store_line("[sub_resource type=\"ProceduralSky\" id=1]");
	f->store_line("[resource]");
	f->store_line("background_mode = 2");
	f->store_line("background_sky = SubResource( 1 )");

Add --init cli argument to create new projects #25925

Add --init cli argument to create new projects #25925

Conversation

lupoDharkael commented Feb 16, 2019

Calinou commented Feb 16, 2019 • edited Loading

lupoDharkael commented Feb 16, 2019

bojidar-bg commented Feb 16, 2019

lupoDharkael commented Feb 16, 2019

lupoDharkael commented Feb 17, 2019

hpvb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Calinou Feb 18, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Xrayez commented Apr 21, 2019

lupoDharkael commented Apr 21, 2019

Choose a reason for hiding this comment

akien-mga commented Oct 30, 2019

aaronfranke commented Jun 17, 2020

Calinou commented Feb 16, 2019 •

edited

Loading

Calinou Feb 18, 2019 •

edited

Loading