2
0

EditorExportPlatformWindows.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  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. The Windows exporter customizes how a Windows build is handled. In the editor's "Export" window, it is created when adding a new "Windows" preset.
  8. </description>
  9. <tutorials>
  10. <link title="Exporting for Windows">$DOCS_URL/tutorials/export/exporting_for_windows.html</link>
  11. </tutorials>
  12. <members>
  13. <member name="application/company_name" type="String" setter="" getter="">
  14. Company that produced the application. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  15. </member>
  16. <member name="application/console_wrapper_icon" type="String" setter="" getter="">
  17. 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].
  18. </member>
  19. <member name="application/copyright" type="String" setter="" getter="">
  20. 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].
  21. </member>
  22. <member name="application/d3d12_agility_sdk_multiarch" type="bool" setter="" getter="">
  23. If [code]true[/code], and [member application/export_d3d12] is set, the Agility SDK DLLs will be stored in arch-specific subdirectories.
  24. </member>
  25. <member name="application/export_angle" type="int" setter="" getter="">
  26. If set to [code]1[/code], ANGLE libraries are exported with the exported application. If set to [code]0[/code], ANGLE libraries are exported only if [member ProjectSettings.rendering/gl_compatibility/driver] is set to [code]"opengl3_angle"[/code].
  27. </member>
  28. <member name="application/export_d3d12" type="int" setter="" getter="">
  29. If set to [code]1[/code], the Direct3D 12 runtime libraries (Agility SDK, PIX) are exported with the exported application. If set to [code]0[/code], Direct3D 12 libraries are exported only if [member ProjectSettings.rendering/rendering_device/driver] is set to [code]"d3d12"[/code].
  30. </member>
  31. <member name="application/file_description" type="String" setter="" getter="">
  32. File description to be presented to users. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  33. </member>
  34. <member name="application/file_version" type="String" setter="" getter="">
  35. 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].
  36. </member>
  37. <member name="application/icon" type="String" setter="" getter="">
  38. 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].
  39. </member>
  40. <member name="application/icon_interpolation" type="int" setter="" getter="">
  41. Interpolation method used to resize application icon.
  42. </member>
  43. <member name="application/modify_resources" type="bool" setter="" getter="">
  44. If enabled, icon and metadata of the exported executable is set according to the other [code]application/*[/code] values.
  45. </member>
  46. <member name="application/product_name" type="String" setter="" getter="">
  47. Name of the application. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].
  48. </member>
  49. <member name="application/product_version" type="String" setter="" getter="">
  50. 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].
  51. </member>
  52. <member name="application/trademarks" type="String" setter="" getter="">
  53. 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].
  54. </member>
  55. <member name="binary_format/architecture" type="String" setter="" getter="">
  56. Application executable architecture.
  57. Supported architectures: [code]x86_32[/code], [code]x86_64[/code], and [code]arm64[/code].
  58. </member>
  59. <member name="binary_format/embed_pck" type="bool" setter="" getter="">
  60. If [code]true[/code], project resources are embedded into the executable.
  61. </member>
  62. <member name="codesign/custom_options" type="PackedStringArray" setter="" getter="">
  63. 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].
  64. </member>
  65. <member name="codesign/description" type="String" setter="" getter="">
  66. Description of the signed content. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  67. </member>
  68. <member name="codesign/digest_algorithm" type="int" setter="" getter="">
  69. Digest algorithm to use for creating signature. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  70. </member>
  71. <member name="codesign/enable" type="bool" setter="" getter="">
  72. If [code]true[/code], executable signing is enabled.
  73. </member>
  74. <member name="codesign/identity" type="String" setter="" getter="">
  75. 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].
  76. Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_IDENTITY[/code].
  77. </member>
  78. <member name="codesign/identity_type" type="int" setter="" getter="">
  79. Type of identity to use. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].
  80. Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_IDENTITY_TYPE[/code].
  81. </member>
  82. <member name="codesign/password" type="String" setter="" getter="">
  83. 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].
  84. Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_PASSWORD[/code].
  85. </member>
  86. <member name="codesign/timestamp" type="bool" setter="" getter="">
  87. 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].
  88. </member>
  89. <member name="codesign/timestamp_server_url" type="String" setter="" getter="">
  90. 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].
  91. </member>
  92. <member name="custom_template/debug" type="String" setter="" getter="">
  93. Path to the custom export template. If left empty, default template is used.
  94. </member>
  95. <member name="custom_template/release" type="String" setter="" getter="">
  96. Path to the custom export template. If left empty, default template is used.
  97. </member>
  98. <member name="debug/export_console_wrapper" type="int" setter="" getter="">
  99. If [code]true[/code], a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output.
  100. </member>
  101. <member name="shader_baker/enabled" type="bool" setter="" getter="">
  102. If [code]true[/code], shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers.
  103. [b]Note:[/b] When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed.
  104. </member>
  105. <member name="ssh_remote_deploy/cleanup_script" type="String" setter="" getter="">
  106. Script code to execute on the remote host when app is finished.
  107. The following variables can be used in the script:
  108. - [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to.
  109. - [code]{archive_name}[/code] - Name of the ZIP containing uploaded application.
  110. - [code]{exe_name}[/code] - Name of application executable.
  111. - [code]{cmd_args}[/code] - Array of the command line argument for the application.
  112. </member>
  113. <member name="ssh_remote_deploy/enabled" type="bool" setter="" getter="">
  114. Enables remote deploy using SSH/SCP.
  115. </member>
  116. <member name="ssh_remote_deploy/extra_args_scp" type="String" setter="" getter="">
  117. Array of the additional command line arguments passed to the SCP.
  118. </member>
  119. <member name="ssh_remote_deploy/extra_args_ssh" type="String" setter="" getter="">
  120. Array of the additional command line arguments passed to the SSH.
  121. </member>
  122. <member name="ssh_remote_deploy/host" type="String" setter="" getter="">
  123. Remote host SSH user name and address, in [code]user@address[/code] format.
  124. </member>
  125. <member name="ssh_remote_deploy/port" type="String" setter="" getter="">
  126. Remote host SSH port number.
  127. </member>
  128. <member name="ssh_remote_deploy/run_script" type="String" setter="" getter="">
  129. Script code to execute on the remote host when running the app.
  130. The following variables can be used in the script:
  131. - [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to.
  132. - [code]{archive_name}[/code] - Name of the ZIP containing uploaded application.
  133. - [code]{exe_name}[/code] - Name of application executable.
  134. - [code]{cmd_args}[/code] - Array of the command line argument for the application.
  135. </member>
  136. <member name="texture_format/etc2_astc" type="bool" setter="" getter="">
  137. If [code]true[/code], project textures are exported in the ETC2/ASTC format.
  138. </member>
  139. <member name="texture_format/s3tc_bptc" type="bool" setter="" getter="">
  140. If [code]true[/code], project textures are exported in the S3TC/BPTC format.
  141. </member>
  142. </members>
  143. </class>