-
-
Notifications
You must be signed in to change notification settings - Fork 21.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Export] Add readable descriptions and validation warnings to the exp…
…ort options.
- Loading branch information
Showing
49 changed files
with
2,213 additions
and
389 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| <?xml version="1.0" encoding="UTF-8" ?> | ||
| <class name="EditorExportPlatformIOS" inherits="EditorExportPlatform" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | ||
| <brief_description> | ||
| Exporter for iOS. | ||
| </brief_description> | ||
| <description> | ||
| </description> | ||
| <tutorials> | ||
| <link title="Exporting for iOS">$DOCS_URL/tutorials/export/exporting_for_ios.html</link> | ||
| </tutorials> | ||
| <members> | ||
| <member name="application/app_store_team_id" type="String" setter="" getter=""> | ||
| Apple Team ID, unique 10-character string. To locate your Team ID check "Membership details" section in your Apple developer account dashboard, or "Organisational Unit" of your code signing certificate. See [url=https://developer.apple.com/help/account/manage-your-team/locate-your-team-id]Locate your Team ID[/url]. | ||
| </member> | ||
| <member name="application/bundle_identifier" type="String" setter="" getter=""> | ||
| Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters ([code]A-Z[/code], [code]a-z[/code], and [code]0-9[/code]), hyphens ([code]-[/code]), and periods ([code].[/code]). | ||
| </member> | ||
| <member name="application/code_sign_identity_debug" type="String" setter="" getter=""> | ||
| The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for debug export. | ||
| </member> | ||
| <member name="application/code_sign_identity_release" type="String" setter="" getter=""> | ||
| The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for release export. | ||
| </member> | ||
| <member name="application/export_method_debug" type="int" setter="" getter=""> | ||
| Application distribution target (debug export). | ||
| </member> | ||
| <member name="application/export_method_release" type="int" setter="" getter=""> | ||
| Application distribution target (release export). | ||
| </member> | ||
| <member name="application/icon_interpolation" type="int" setter="" getter=""> | ||
| Interpolation method used to resize application icon. | ||
| </member> | ||
| <member name="application/launch_screens_interpolation" type="int" setter="" getter=""> | ||
| Interpolation method used to resize launch screen images. | ||
| </member> | ||
| <member name="application/provisioning_profile_uuid_debug" type="String" setter="" getter=""> | ||
| UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See [url=https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles]Edit, download, or delete provisioning profiles[/url]. | ||
| </member> | ||
| <member name="application/provisioning_profile_uuid_release" type="String" setter="" getter=""> | ||
| UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See [url=https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles]Edit, download, or delete provisioning profiles[/url]. | ||
| </member> | ||
| <member name="application/short_version" type="String" setter="" getter=""> | ||
| Application version visible to the user, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). | ||
| </member> | ||
| <member name="application/signature" type="String" setter="" getter=""> | ||
| A four-character creator code that is specific to the bundle. Optional. | ||
| </member> | ||
| <member name="application/targeted_device_family" type="int" setter="" getter=""> | ||
| Supported device family. | ||
| </member> | ||
| <member name="application/version" type="String" setter="" getter=""> | ||
| Machine-readable application version, in the [code]major.minor.patch[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). | ||
| </member> | ||
| <member name="architectures/arm64" type="bool" setter="" getter=""> | ||
| If [code]true[/code], [code]arm64[/code] binaries are included into exported project. | ||
| </member> | ||
| <member name="capabilities/access_wifi" type="bool" setter="" getter=""> | ||
| If [code]true[/code], networking features related to Wi-Fi access are enabled. See [url=https://developer.apple.com/support/required-device-capabilities/]Required Device Capabilities[/url]. | ||
| </member> | ||
| <member name="capabilities/push_notifications" type="bool" setter="" getter=""> | ||
| If [code]true[/code], push notifications are enabled. See [url=https://developer.apple.com/support/required-device-capabilities/]Required Device Capabilities[/url]. | ||
| </member> | ||
| <member name="custom_template/debug" type="String" setter="" getter=""> | ||
| Path to the custom export template. If left empty, default template is used. | ||
| </member> | ||
| <member name="custom_template/release" type="String" setter="" getter=""> | ||
| Path to the custom export template. If left empty, default template is used. | ||
| </member> | ||
| <member name="icons/app_store_1024x1024" type="String" setter="" getter=""> | ||
| App Store application icon file. If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/ipad_152x152" type="String" setter="" getter=""> | ||
| Home screen application icon file on iPad (2x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/ipad_167x167" type="String" setter="" getter=""> | ||
| Home screen application icon file on iPad (3x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/ipad_76x76" type="String" setter="" getter=""> | ||
| Home screen application icon file on iPad (1x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/iphone_120x120" type="String" setter="" getter=""> | ||
| Home screen application icon file on iPhone (2x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/iphone_180x180" type="String" setter="" getter=""> | ||
| Home screen application icon file on iPhone (3x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/notification_40x40" type="String" setter="" getter=""> | ||
| Notification icon file on iPad and iPhone (2x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/notification_60x60" type="String" setter="" getter=""> | ||
| Notification icon file on iPhone (3x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/settings_58x58" type="String" setter="" getter=""> | ||
| Application settings icon file on iPad and iPhone (2x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/settings_87x87" type="String" setter="" getter=""> | ||
| Application settings icon file on iPhone (3x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/spotlight_40x40" type="String" setter="" getter=""> | ||
| Spotlight icon file on iPad (1x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="icons/spotlight_80x80" type="String" setter="" getter=""> | ||
| Spotlight icon file on iPad and iPhone (2x DPI). If left empty, project icon is used instead. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url]. | ||
| </member> | ||
| <member name="landscape_launch_screens/ipad_1024x768" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="landscape_launch_screens/ipad_2048x1536" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="landscape_launch_screens/iphone_2208x1242" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="landscape_launch_screens/iphone_2436x1125" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="portrait_launch_screens/ipad_1536x2048" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="portrait_launch_screens/ipad_768x1024" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="portrait_launch_screens/iphone_1125x2436" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="portrait_launch_screens/iphone_1242x2208" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="portrait_launch_screens/iphone_640x1136" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="portrait_launch_screens/iphone_640x960" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="portrait_launch_screens/iphone_750x1334" type="String" setter="" getter=""> | ||
| Application launch screen image file, if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="privacy/camera_usage_description" type="String" setter="" getter=""> | ||
| A message displayed when requesting access to the device's camera (in English). | ||
| </member> | ||
| <member name="privacy/camera_usage_description_localized" type="Dictionary" setter="" getter=""> | ||
| A message displayed when requesting access to the device's camera (localized). | ||
| </member> | ||
| <member name="privacy/microphone_usage_description" type="String" setter="" getter=""> | ||
| A message displayed when requesting access to the device's microphone (in English). | ||
| </member> | ||
| <member name="privacy/microphone_usage_description_localized" type="Dictionary" setter="" getter=""> | ||
| A message displayed when requesting access to the device's microphone (localized). | ||
| </member> | ||
| <member name="privacy/photolibrary_usage_description" type="String" setter="" getter=""> | ||
| A message displayed when requesting access to the user's photo library (in English). | ||
| </member> | ||
| <member name="privacy/photolibrary_usage_description_localized" type="Dictionary" setter="" getter=""> | ||
| A message displayed when requesting access to the user's photo library (localized). | ||
| </member> | ||
| <member name="storyboard/custom_bg_color" type="Color" setter="" getter=""> | ||
| A custom background color of the storyboard launch screen. | ||
| </member> | ||
| <member name="storyboard/custom_image@2x" type="String" setter="" getter=""> | ||
| Application launch screen image file (2x DPI), if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="storyboard/custom_image@3x" type="String" setter="" getter=""> | ||
| Application launch screen image file (3x DPI), if left empty project splash screen is used instead. | ||
| </member> | ||
| <member name="storyboard/image_scale_mode" type="int" setter="" getter=""> | ||
| Launch screen image scaling mode. | ||
| </member> | ||
| <member name="storyboard/use_custom_bg_color" type="bool" setter="" getter=""> | ||
| If [code]true[/code], [member storyboard/custom_bg_color] is used as a launch screen background color, otherwise [code]application/boot_splash/bg_color[/code] project setting is used. | ||
| </member> | ||
| <member name="storyboard/use_launch_screen_storyboard" type="bool" setter="" getter=""> | ||
| If [code]true[/code], storyboard launch screen is used instead of launch screen images. | ||
| </member> | ||
| <member name="user_data/accessible_from_files_app" type="bool" setter="" getter=""> | ||
| If [code]true[/code], the app "Documents" folder can be accessed via "Files" app. See [url=https://developer.apple.com/documentation/bundleresources/information_property_list/lssupportsopeningdocumentsinplace]LSSupportsOpeningDocumentsInPlace[/url]. | ||
| </member> | ||
| <member name="user_data/accessible_from_itunes_sharing" type="bool" setter="" getter=""> | ||
| If [code]true[/code], the app "Documents" folder can be accessed via iTunes file sharing. See [url=https://developer.apple.com/documentation/bundleresources/information_property_list/uifilesharingenabled]UIFileSharingEnabled[/url]. | ||
| </member> | ||
| </members> | ||
| </class> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| <?xml version="1.0" encoding="UTF-8" ?> | ||
| <class name="EditorExportPlatformLinuxBSD" inherits="EditorExportPlatformPC" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | ||
| <brief_description> | ||
| Exporter for Linux/BSD. | ||
| </brief_description> | ||
| <description> | ||
| </description> | ||
| <tutorials> | ||
| <link title="Exporting for Linux">$DOCS_URL/tutorials/export/exporting_for_linux.html</link> | ||
| </tutorials> | ||
| <members> | ||
| <member name="binary_format/architecture" type="String" setter="" getter=""> | ||
| Application executable architecture. | ||
| Supported architectures: [code]x86_32[/code], [code]x86_64[/code], [code]arm64[/code], [code]arm32[/code], [code]rv64[/code], [code]ppc64[/code], and [code]ppc32[/code]. | ||
| Official export templates include [code]x86_32[/code] and [code]x86_64[/code] binaries only. | ||
| </member> | ||
| <member name="binary_format/embed_pck" type="bool" setter="" getter=""> | ||
| If [code]true[/code], project resources are embedded into the executable. | ||
| </member> | ||
| <member name="custom_template/debug" type="String" setter="" getter=""> | ||
| Path to the custom export template. If left empty, default template is used. | ||
| </member> | ||
| <member name="custom_template/release" type="String" setter="" getter=""> | ||
| Path to the custom export template. If left empty, default template is used. | ||
| </member> | ||
| <member name="debug/export_console_script" type="int" setter="" getter=""> | ||
| If [code]true[/code], a console wrapper script is exported alongside the main executable, which allows running the project with enabled console output. | ||
| </member> | ||
| <member name="ssh_remote_deploy/cleanup_script" type="String" setter="" getter=""> | ||
| Script code to execute on the remote host when app is finished. | ||
| The following variables can be used in the script: | ||
| - [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to. | ||
| - [code]{archive_name}[/code] - Name of the ZIP containing uploaded application. | ||
| - [code]{exe_name}[/code] - Name of application executable. | ||
| - [code]{cmd_args}[/code] - Array of the command line argument for the application. | ||
| </member> | ||
| <member name="ssh_remote_deploy/enabled" type="bool" setter="" getter=""> | ||
| Enables remote deploy using SSH/SCP. | ||
| </member> | ||
| <member name="ssh_remote_deploy/extra_args_scp" type="String" setter="" getter=""> | ||
| Array of the additional command line arguments passed to the SCP. | ||
| </member> | ||
| <member name="ssh_remote_deploy/extra_args_ssh" type="String" setter="" getter=""> | ||
| Array of the additional command line arguments passed to the SSH. | ||
| </member> | ||
| <member name="ssh_remote_deploy/host" type="String" setter="" getter=""> | ||
| Remote host SSH user name and address, in [code]user@address[/code] format. | ||
| </member> | ||
| <member name="ssh_remote_deploy/port" type="String" setter="" getter=""> | ||
| Remote host SSH port number. | ||
| </member> | ||
| <member name="ssh_remote_deploy/run_script" type="String" setter="" getter=""> | ||
| Script code to execute on the remote host when running the app. | ||
| The following variables can be used in the script: | ||
| - [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to. | ||
| - [code]{archive_name}[/code] - Name of the ZIP containing uploaded application. | ||
| - [code]{exe_name}[/code] - Name of application executable. | ||
| - [code]{cmd_args}[/code] - Array of the command line argument for the application. | ||
| </member> | ||
| <member name="texture_format/bptc" type="bool" setter="" getter=""> | ||
| If [code]true[/code], project textures are exported in the BPTC format. | ||
| </member> | ||
| <member name="texture_format/etc" type="bool" setter="" getter=""> | ||
| If [code]true[/code], project textures are exported in the ETC format. | ||
| </member> | ||
| <member name="texture_format/etc2" type="bool" setter="" getter=""> | ||
| If [code]true[/code], project textures are exported in the ETC2 format. | ||
| </member> | ||
| <member name="texture_format/s3tc" type="bool" setter="" getter=""> | ||
| If [code]true[/code], project textures are exported in the S3TC format. | ||
| </member> | ||
| </members> | ||
| </class> |
Oops, something went wrong.