EditorExportPlatformWindows.xml 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="EditorExportPlatformWindows" inherits="EditorExportPlatformPC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Exporter for Windows.
  5. </brief_description>
  6. <description>
  7. </description>
  8. <tutorials>
  9. <link title="Exporting for Windows">$DOCS_URL/tutorials/export/exporting_for_windows.html</link>
  10. </tutorials>
  11. <members>
  12. <member name="application/company_name" type="String" setter="" getter="">
  13. Company that produced the application. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  14. </member>
  15. <member name="application/console_wrapper_icon" type="String" setter="" getter="">
  16. Console wrapper icon file. If left empty, it will fallback to [member application/icon], then to [member ProjectSettings.application/config/windows_native_icon], and lastly, [member ProjectSettings.application/config/icon].
  17. </member>
  18. <member name="application/copyright" type="String" setter="" getter="">
  19. Copyright notice for the bundle visible to the user. Optional. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  20. </member>
  21. <member name="application/file_description" type="String" setter="" getter="">
  22. File description to be presented to users. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  23. </member>
  24. <member name="application/file_version" type="String" setter="" getter="">
  25. Version number of the file. Falls back to [member ProjectSettings.application/config/version] if left empty. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  26. </member>
  27. <member name="application/icon" type="String" setter="" getter="">
  28. Application icon file. If left empty, it will fallback to [member ProjectSettings.application/config/windows_native_icon], and then to [member ProjectSettings.application/config/icon].
  29. </member>
  30. <member name="application/icon_interpolation" type="int" setter="" getter="">
  31. Interpolation method used to resize application icon.
  32. </member>
  33. <member name="application/modify_resources" type="bool" setter="" getter="">
  34. If enabled, icon and metadata of the exported executable is set according to the other [code]application/*[/code] values.
  35. </member>
  36. <member name="application/product_name" type="String" setter="" getter="">
  37. Name of the application. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  38. </member>
  39. <member name="application/product_version" type="String" setter="" getter="">
  40. Application version visible to the user. Falls back to [member ProjectSettings.application/config/version] if left empty. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  41. </member>
  42. <member name="application/trademarks" type="String" setter="" getter="">
  43. Trademarks and registered trademarks that apply to the file. Optional. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  44. </member>
  45. <member name="binary_format/architecture" type="String" setter="" getter="">
  46. Application executable architecture.
  47. Supported architectures: [code]x86_32[/code], [code]x86_64[/code], and [code]arm64[/code].
  48. Official export templates include [code]x86_32[/code] and [code]x86_64[/code] binaries only.
  49. </member>
  50. <member name="binary_format/embed_pck" type="bool" setter="" getter="">
  51. If [code]true[/code], project resources are embedded into the executable.
  52. </member>
  53. <member name="codesign/custom_options" type="PackedStringArray" setter="" getter="">
  54. Array of the additional command line arguments passed to the code signing tool. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  55. </member>
  56. <member name="codesign/description" type="String" setter="" getter="">
  57. Description of the signed content. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  58. </member>
  59. <member name="codesign/digest_algorithm" type="int" setter="" getter="">
  60. Digest algorithm to use for creating signature. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  61. </member>
  62. <member name="codesign/enable" type="bool" setter="" getter="">
  63. If [code]true[/code], executable signing is enabled.
  64. </member>
  65. <member name="codesign/identity" type="String" setter="" getter="">
  66. PKCS #12 certificate file used to sign executable or certificate SHA-1 hash (if [member codesign/identity_type] is set to "Use certificate store"). See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  67. Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_IDENTITY[/code].
  68. </member>
  69. <member name="codesign/identity_type" type="int" setter="" getter="">
  70. Type of identity to use. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  71. Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_IDENTITY_TYPE[/code].
  72. </member>
  73. <member name="codesign/password" type="String" setter="" getter="">
  74. Password for the certificate file used to sign executable. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  75. Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_PASSWORD[/code].
  76. </member>
  77. <member name="codesign/timestamp" type="bool" setter="" getter="">
  78. If [code]true[/code], time-stamp is added to the signature. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  79. </member>
  80. <member name="codesign/timestamp_server_url" type="String" setter="" getter="">
  81. URL of the time stamp server. If left empty, the default server is used. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  82. </member>
  83. <member name="custom_template/debug" type="String" setter="" getter="">
  84. Path to the custom export template. If left empty, default template is used.
  85. </member>
  86. <member name="custom_template/release" type="String" setter="" getter="">
  87. Path to the custom export template. If left empty, default template is used.
  88. </member>
  89. <member name="debug/export_console_wrapper" type="int" setter="" getter="">
  90. If [code]true[/code], a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output.
  91. </member>
  92. <member name="ssh_remote_deploy/cleanup_script" type="String" setter="" getter="">
  93. Script code to execute on the remote host when app is finished.
  94. The following variables can be used in the script:
  95. - [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to.
  96. - [code]{archive_name}[/code] - Name of the ZIP containing uploaded application.
  97. - [code]{exe_name}[/code] - Name of application executable.
  98. - [code]{cmd_args}[/code] - Array of the command line argument for the application.
  99. </member>
  100. <member name="ssh_remote_deploy/enabled" type="bool" setter="" getter="">
  101. Enables remote deploy using SSH/SCP.
  102. </member>
  103. <member name="ssh_remote_deploy/extra_args_scp" type="String" setter="" getter="">
  104. Array of the additional command line arguments passed to the SCP.
  105. </member>
  106. <member name="ssh_remote_deploy/extra_args_ssh" type="String" setter="" getter="">
  107. Array of the additional command line arguments passed to the SSH.
  108. </member>
  109. <member name="ssh_remote_deploy/host" type="String" setter="" getter="">
  110. Remote host SSH user name and address, in [code]user@address[/code] format.
  111. </member>
  112. <member name="ssh_remote_deploy/port" type="String" setter="" getter="">
  113. Remote host SSH port number.
  114. </member>
  115. <member name="ssh_remote_deploy/run_script" type="String" setter="" getter="">
  116. Script code to execute on the remote host when running the app.
  117. The following variables can be used in the script:
  118. - [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to.
  119. - [code]{archive_name}[/code] - Name of the ZIP containing uploaded application.
  120. - [code]{exe_name}[/code] - Name of application executable.
  121. - [code]{cmd_args}[/code] - Array of the command line argument for the application.
  122. </member>
  123. <member name="texture_format/bptc" type="bool" setter="" getter="">
  124. If [code]true[/code], project textures are exported in the BPTC format.
  125. </member>
  126. <member name="texture_format/etc" type="bool" setter="" getter="">
  127. If [code]true[/code], project textures are exported in the ETC format.
  128. </member>
  129. <member name="texture_format/etc2" type="bool" setter="" getter="">
  130. If [code]true[/code], project textures are exported in the ETC2 format.
  131. </member>
  132. <member name="texture_format/s3tc" type="bool" setter="" getter="">
  133. If [code]true[/code], project textures are exported in the S3TC format.
  134. </member>
  135. </members>
  136. </class>