Add default value of editor property `export/android/android_sdk_path` for Windows, Linux, and macOS #97992

Nikitf777 · 2024-10-08T21:28:52Z

[It is reopened #97978]

It was always annoying to me to start android development in Godot because it doesn't work out of the box, despite the fact that it's completely possible (Android Studio is a prove).
In particular, for some reason, I always need to manually set Android SDK path, which is almost (if not completely) always the same within each OS family when installed from Android Studio with default settings.

So now Godot has default value of Android SDK path for every supported OS:

Windows: %LOCALAPPDATA%/Android/Sdk
Linux: $HOME/Android/Sdk
macOS: $HOME/Library/Android/Sdk

Tested on Linux and Windows (through wine).

Calinou · 2024-10-11T09:12:55Z

platform/linuxbsd/os_linuxbsd.cpp

@@ -1180,6 +1180,10 @@ String OS_LinuxBSD::get_system_ca_certificates() {
 	return f->get_as_text();
 }

+String OS_LinuxBSD::get_default_android_sdk_path() const {
+	return OS::get_singleton()->get_environment("HOME") + "/Android/Sdk";


Handle trailing slashes if present in the environment variable (very unlikely here, but could technically happen):

Suggested change

return OS::get_singleton()->get_environment("HOME") + "/Android/Sdk";

return OS::get_singleton()->get_environment("HOME").path_join("Android/Sdk");

Calinou · 2024-10-11T09:13:10Z

platform/macos/os_macos.mm

@@ -763,6 +763,10 @@
 	return certs;
 }

+String OS_MacOS::get_default_android_sdk_path() const {
+	return OS::get_singleton()->get_environment("HOME") + "/Library/Android/Sdk";


Suggested change

return OS::get_singleton()->get_environment("HOME") + "/Library/Android/Sdk";

return OS::get_singleton()->get_environment("HOME").path_join("Library/Android/Sdk");

Calinou · 2024-10-11T09:13:32Z

platform/windows/os_windows.cpp

@@ -2004,6 +2004,10 @@ String OS_Windows::get_system_ca_certificates() {
 	return certs;
 }

+String OS_Windows::get_default_android_sdk_path() const {
+	return OS::get_singleton()->get_environment("LOCALAPPDATA") + "\\Android\\Sdk";


Suggested change

return OS::get_singleton()->get_environment("LOCALAPPDATA") + "\\Android\\Sdk";

return OS::get_singleton()->get_environment("LOCALAPPDATA").path_join("Android\\Sdk");

Calinou · 2024-10-11T09:14:50Z

platform/android/export/export.cpp

@@ -52,7 +52,9 @@ void register_android_exporter() {
 #ifndef ANDROID_ENABLED
 	EDITOR_DEF_BASIC("export/android/java_sdk_path", OS::get_singleton()->get_environment("JAVA_HOME"));
 	EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/java_sdk_path", PROPERTY_HINT_GLOBAL_DIR));
-	EDITOR_DEF_BASIC("export/android/android_sdk_path", OS::get_singleton()->get_environment("ANDROID_HOME"));
+
+	EDITOR_DEF_BASIC("export/android/android_sdk_path", OS::get_singleton()->has_environment("ANDROID_HOME") ? OS::get_singleton()->get_environment("ANDROID_HOME") : OS::get_singleton()->get_default_android_sdk_path());


I wonder why the Android installers don't define ANDROID_HOME to the user environment variables after installing Android Studio. If they consistently did this, then this step wouldn't be needed.

I think it's due to Linux's mess in environment variables. While in windows they are stored compactly and conveniently in one place in registry, in Linux there plenty of places for both user and global variables. And what makes it even worse is the fact that this set of places depends on DE and shell you currently use (and maybe distro, if we're taking about global vars). Yes, we have "/etc/environment", but you need sudo to write to it. So there's very few examples of non system apps which automatically edit variables

Yes, we have '/etc/environment', but you need sudo to write to it.

On macOS, it's not writable at all, there's no way to set global environment variables. ANDROID_HOME can be set for the shell, but Godot usually is not started from the shell.

platform/linuxbsd/os_linuxbsd.h

bruvzg · 2024-10-11T12:15:36Z

platform/android/export/export.cpp

@@ -52,7 +52,9 @@ void register_android_exporter() {
 #ifndef ANDROID_ENABLED
 	EDITOR_DEF_BASIC("export/android/java_sdk_path", OS::get_singleton()->get_environment("JAVA_HOME"));
 	EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/java_sdk_path", PROPERTY_HINT_GLOBAL_DIR));
-	EDITOR_DEF_BASIC("export/android/android_sdk_path", OS::get_singleton()->get_environment("ANDROID_HOME"));
+
+	EDITOR_DEF_BASIC("export/android/android_sdk_path", OS::get_singleton()->has_environment("ANDROID_HOME") ? OS::get_singleton()->get_environment("ANDROID_HOME") : OS::get_singleton()->get_default_android_sdk_path());


Yes, we have '/etc/environment', but you need sudo to write to it.

On macOS, it's not writable at all, there's no way to set global environment variables. ANDROID_HOME can be set for the shell, but Godot usually is not started from the shell.

Nikitf777 · 2024-10-13T20:43:12Z

platform/android/export/export.cpp

+
+String get_default_android_sdk_path() {
+#ifdef WINDOWS_ENABLED
+	return OS::get_singleton()->get_environment("LOCALAPPDATA").path_join("Android/Sdk");


I replaced backslash with forward slash because String::path_join() method uses these slashes as well (So in any case sdk path on Windows will contain both back and forward slashes, because Windows' environment variables always use backslashes.

m4gr3d · 2024-10-14T05:58:11Z

platform/android/export/export.cpp

@@ -37,6 +37,8 @@
 #include "editor/editor_settings.h"
 #include "editor/export/editor_export.h"

+String get_default_android_sdk_path();


Can you move this method to EditorPaths for consistency.

I actually think this should be in platform/android/export/export.cpp as it's specific to the Android export pipeline and we should aim to keep solutions local.

m4gr3d · 2024-10-14T05:58:36Z

platform/macos/os_macos.h

@@ -126,6 +126,7 @@ class OS_MacOS : public OS_Unix {
 	virtual Error move_to_trash(const String &p_path) override;

 	virtual String get_system_ca_certificates() override;
+


Can be reverted?

m4gr3d

Looks good!

Can you squash the commits.

akien-mga · 2024-11-11T12:33:38Z

editor/editor_paths.cpp

+#elif LINUXBSD_ENABLED
+	return OS::get_singleton()->get_environment("HOME").path_join("Android/Sdk");


Could you clarify what installation process leads to the Android SDK being in this path on Linux?

In my case I install the Android SDK from the command line tools from Google and thus the path is whatever I unzip the tools at, and pass as --sdk_root to sdkmanager.

Is ~/Android/Sdk the default path used by Android Studio on Linux?

Yes, in my case (and according to web search, not only in mine) Android Studio (no matter if it's snap, flatpak or official version) always use ~/Android location for its files, including the SDK.

akien-mga · 2024-11-11T20:55:43Z

Sorry for the back and forth on this but I think the helper method to get the default SDK path should be in the Android export.cpp file as it's only useful there, and it's not a generic Godot path.

…" for Windows, Linux, and macOS

Repiteo · 2024-11-18T15:30:54Z

Thanks! Congratulations on your first contribution! 🎉

Nikitf777 requested review from a team as code owners October 8, 2024 21:28

AThousandShips added enhancement topic:editor topic:export labels Oct 9, 2024

AThousandShips added this to the 4.x milestone Oct 9, 2024

m4gr3d approved these changes Oct 9, 2024

View reviewed changes

m4gr3d modified the milestones: 4.x, 4.4 Oct 9, 2024

Nikitf777 changed the title ~~Add default value of editor propetry "export/android/android_sdk_path" for Windows, Linux, and macOS~~ Add default value of editor propetry export/android/android_sdk_path for Windows, Linux, and macOS Oct 9, 2024

Calinou reviewed Oct 11, 2024

View reviewed changes

bruvzg reviewed Oct 11, 2024

View reviewed changes

Nikitf777 commented Oct 13, 2024

View reviewed changes

m4gr3d requested changes Oct 14, 2024

View reviewed changes

Nikitf777 requested a review from a team as a code owner October 14, 2024 14:39

m4gr3d approved these changes Oct 14, 2024

View reviewed changes

Nikitf777 force-pushed the android-sdk-path branch from 2f51dc1 to 3411a26 Compare October 14, 2024 16:50

akien-mga changed the title ~~Add default value of editor propetry export/android/android_sdk_path for Windows, Linux, and macOS~~ Add default value of editor property export/android/android_sdk_path for Windows, Linux, and macOS Nov 11, 2024

akien-mga reviewed Nov 11, 2024

View reviewed changes

Add default value of editor propetry "export/android/android_sdk_path…

c6f4228

…" for Windows, Linux, and macOS

Nikitf777 force-pushed the android-sdk-path branch from 3411a26 to c6f4228 Compare November 17, 2024 19:26

Repiteo merged commit 8811b39 into godotengine:master Nov 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add default value of editor property `export/android/android_sdk_path` for Windows, Linux, and macOS #97992

Add default value of editor property `export/android/android_sdk_path` for Windows, Linux, and macOS #97992

Nikitf777 commented Oct 8, 2024 •

edited

Loading

Calinou Oct 11, 2024 •

edited

Loading

Calinou Oct 11, 2024 •

edited

Loading

Calinou Oct 11, 2024

Calinou Oct 11, 2024 •

edited

Loading

Nikitf777 Oct 11, 2024 •

edited

Loading

bruvzg Oct 11, 2024

bruvzg Oct 11, 2024

Nikitf777 Oct 13, 2024 •

edited

Loading

m4gr3d Oct 14, 2024

akien-mga Nov 11, 2024

m4gr3d Oct 14, 2024

m4gr3d left a comment

akien-mga Nov 11, 2024

Nikitf777 Nov 11, 2024 •

edited

Loading

akien-mga commented Nov 11, 2024

Repiteo commented Nov 18, 2024

	return OS::get_singleton()->get_environment("HOME") + "/Android/Sdk";
	return OS::get_singleton()->get_environment("HOME").path_join("Android/Sdk");

		@@ -126,6 +126,7 @@ class OS_MacOS : public OS_Unix {
		virtual Error move_to_trash(const String &p_path) override;

		virtual String get_system_ca_certificates() override;

		#elif LINUXBSD_ENABLED
		return OS::get_singleton()->get_environment("HOME").path_join("Android/Sdk");

Add default value of editor property export/android/android_sdk_path for Windows, Linux, and macOS #97992

Add default value of editor property export/android/android_sdk_path for Windows, Linux, and macOS #97992

Conversation

Nikitf777 commented Oct 8, 2024 • edited Loading

Calinou Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

Calinou Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

Calinou Oct 11, 2024

Choose a reason for hiding this comment

Calinou Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

Nikitf777 Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

bruvzg Oct 11, 2024

Choose a reason for hiding this comment

bruvzg Oct 11, 2024

Choose a reason for hiding this comment

Nikitf777 Oct 13, 2024 • edited Loading

Choose a reason for hiding this comment

m4gr3d Oct 14, 2024

Choose a reason for hiding this comment

akien-mga Nov 11, 2024

Choose a reason for hiding this comment

m4gr3d Oct 14, 2024

Choose a reason for hiding this comment

m4gr3d left a comment

Choose a reason for hiding this comment

akien-mga Nov 11, 2024

Choose a reason for hiding this comment

Nikitf777 Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

akien-mga commented Nov 11, 2024

Repiteo commented Nov 18, 2024

Add default value of editor property `export/android/android_sdk_path` for Windows, Linux, and macOS #97992

Add default value of editor property `export/android/android_sdk_path` for Windows, Linux, and macOS #97992

Nikitf777 commented Oct 8, 2024 •

edited

Loading

Calinou Oct 11, 2024 •

edited

Loading

Calinou Oct 11, 2024 •

edited

Loading

Calinou Oct 11, 2024 •

edited

Loading

Nikitf777 Oct 11, 2024 •

edited

Loading

Nikitf777 Oct 13, 2024 •

edited

Loading

Nikitf777 Nov 11, 2024 •

edited

Loading