Add function to get exported application version / product version

[sriedi7]

Describe the project you are working on:
Irrelevant

Describe the problem or limitation you are having in your project:
You can't get the version of the app or game that you export.

Describe how this feature / enhancement will help you overcome this problem or limitation:
Make it easier to get version of my exported app.

Show a mock up screenshots/video or a flow diagram explaining how your proposal will work:
Irrelevant

Describe implementation detail for your proposal (in code), if possible:
In the export preset there is a version field, example:
Android: Preset > Options > Version > Name
Windows: Preset > Options > Application > Product Version
etc
So these version should be available to get from Godot API.
My suggestion would be:
OS.get_product_version()
or
OS.get_application_version()

If this enhancement will not be used often, can it be worked around with a few lines of script?:
Right now I use the project setting to make custom string field to write my game version and get it using ProjectSettings.get_setting(). But is not so effective because I have to edit it manually whenever I update my app version in export preset.

Is there a reason why this should be core and not an add-on in the asset library?:
Because it is important.

[clayjohn]

Is that not what Engine.get_version_info().build returns?

[sriedi7]

Is that not what Engine.get_version_info().build returns?

tested just now on 3.2b5 it return 'official'

And I mean is not the engine version but version of the game you exported. The version that you type in Export Preset > Options

[Calinou]

You can define a custom project setting for this purpose (e.g. application/config/version). I'm not sure if it's technically feasible to return information from export presets at run-time, since export_presets.cfg isn't included in the exported PCK.

[sriedi7]

Maybe store the value somewhere on export?
Or read from executable?

[Calinou]

Reading from the executable is something I'd consider overkill. It's also not possible on all platforms in the first place 🙂

Either way, my issue with this proposal is that not all platforms define the same metadata for each platform. If you want to access this metadata in a consistent manner cross platforms, you should define a project setting. To avoid repetition in export presets, we could do the following:

• Add a built-in application/config/version project setting which defaults to something like 0.1.0. It can be changed by the user at any time.
• Rename version fields to "custom version" fields in export presets. If those fields are left empty (which is the default), the value in the project settings will be used by default. This means there's now a "single source of truth" for the project version, which can be easily read in a script by using ProjectSettings.get_setting("application/config/version").

If this sounds good to you, I can look into implementing this.

[sriedi7]

Yes, that's sounds good!

[SilvanaP]

From which version on is this available? It would be really nice to have access to the version code that is defined in the "export" panel in Android. I don't really want to have to set it in the ProjectSettings, additionally.

Forget what I wrote, this works like a charm on droid. Only thing to do is to add export_presets.cfg to the exported files in the export dialog:

if OS.get_name() == "Android":
    var export_config: ConfigFile = ConfigFile.new()
    var err = export_config.load("res://export_presets.cfg")
    if err == OK:
        print(export_config.get_value("preset.1.options", 'version/code'))
        print(export_config.get_value("preset.1.options", 'version/name'))
    else:
        print('[engine_root] Error open export_presets.cfgs')

[Calinou]

Forget what I wrote, this works like a charm on droid. Only thing to do is to add export_presets.cfg to the exported files in the export dialog:

If you have an Android export preset, export_presets.cfg contains sensitive information like Android keystore credentials. If you add export_presets.cfg to the non-resource export filter, you will leak your release keystore credentials! Release keystores cannot be reset once your application is published on Google Play, so you need to be very careful around this.

[KoBeWi]

Only thing to do is to add export_presets.cfg to the exported files in the export dialog:

You don't need to include the whole export presets, you can create EditorExporPlugin that extracts version information to a file that will then be included with the build:

	func _export_begin(features: PoolStringArray, is_debug: bool, path: String, flags: int):
                var version = ""
                var export_config: ConfigFile = ConfigFile.new()
                var err = export_config.load("res://export_presets.cfg")
                if err == OK:
                    version = export_config.get_value("preset.1.options", 'version/code') + export_config.get_value("preset.1.options", 'version/name')

		var script = GDScript.new()
		script.source_code = str("extends Reference\nconst VERSION = ", version, "\n")
		ResourceSaver.save("res://version.gd", script)

Then anywhere in the project you can do print(load("res://version.gd").VERSION)

[KoBeWi]

Ok here's a plugin based on the above code:
https://github.com/KoBeWi/Godot-Auto-Export-Version
It will automatically fetch your project version from the profile whenever you export the project.

[blurrred]

Here's a little method that should give the Android app version with an Android plugin. It's pretty simple and straightforward if you're already using a custom Android plugin.

public int getVersion() throws PackageManager.NameNotFoundException {
		PackageManager manager = getActivity().getPackageManager();
		PackageInfo info = manager.getPackageInfo(getActivity().getPackageName(), PackageManager.GET_ACTIVITIES);
		return info.versionCode;
	}

[SteveSmith16384]

This issue does beg the question, what is/was the point of the File Version/Product version fields when exporting to (say) Windows? Is it actually shown or used anywhere?

[YuriSizov]

It is available in the "Properties" dialog, if you right click on the executable. It is useful in some cases, but it's mostly useful to you as a developer, so you can attribute bugs and issues to a specific version.

[SteveSmith16384]

When I view my exe's properties I get the Godot version, and even the Product Name says "Godot Engine", even though I've specified my own in the Export settings. (Godot v3.4.2 in case it's relevant).

[YuriSizov]

If you've specified them but they don't get written, that's probably because you don't have rcedit, or it just doesn't work (because it's not very reliable).

But I can confirm that it should work in principle: