:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/platform/linuxbsd/doc_classes/EditorExportPlatformLinuxBSD.xml. .. _class_EditorExportPlatformLinuxBSD: EditorExportPlatformLinuxBSD ============================ **Inherits:** :ref:`EditorExportPlatformPC` **<** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` Exporter for Linux/BSD. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Exporting for Linux <../tutorials/export/exporting_for_linux>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`binary_format/architecture` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`binary_format/embed_pck` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`custom_template/debug` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`custom_template/release` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/export_console_wrapper` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_scp` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_ssh` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/host` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/port` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/run_script` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`texture_format/etc2_astc` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`texture_format/s3tc_bptc` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_EditorExportPlatformLinuxBSD_property_binary_format/architecture: .. rst-class:: classref-property :ref:`String` **binary_format/architecture** :ref:`🔗` Application executable architecture. Supported architectures: ``x86_32``, ``x86_64``, ``arm64``, ``arm32``, ``rv64``, ``ppc64``, and ``ppc32``. Official export templates include ``x86_32`` and ``x86_64`` binaries only. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_binary_format/embed_pck: .. rst-class:: classref-property :ref:`bool` **binary_format/embed_pck** :ref:`🔗` If ``true``, project resources are embedded into the executable. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_custom_template/debug: .. rst-class:: classref-property :ref:`String` **custom_template/debug** :ref:`🔗` Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_custom_template/release: .. rst-class:: classref-property :ref:`String` **custom_template/release** :ref:`🔗` Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_debug/export_console_wrapper: .. rst-class:: classref-property :ref:`int` **debug/export_console_wrapper** :ref:`🔗` If ``true``, a console wrapper is exported alongside the main executable, which allows running the project with enabled console output. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/cleanup_script: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/cleanup_script** :ref:`🔗` Script code to execute on the remote host when app is finished. The following variables can be used in the script: - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. - ``{archive_name}`` - Name of the ZIP containing uploaded application. - ``{exe_name}`` - Name of application executable. - ``{cmd_args}`` - Array of the command line argument for the application. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/enabled: .. rst-class:: classref-property :ref:`bool` **ssh_remote_deploy/enabled** :ref:`🔗` Enables remote deploy using SSH/SCP. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/extra_args_scp: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/extra_args_scp** :ref:`🔗` Array of the additional command line arguments passed to the SCP. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/extra_args_ssh: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/extra_args_ssh** :ref:`🔗` Array of the additional command line arguments passed to the SSH. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/host: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/host** :ref:`🔗` Remote host SSH user name and address, in ``user@address`` format. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/port: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/port** :ref:`🔗` Remote host SSH port number. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/run_script: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/run_script** :ref:`🔗` Script code to execute on the remote host when running the app. The following variables can be used in the script: - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. - ``{archive_name}`` - Name of the ZIP containing uploaded application. - ``{exe_name}`` - Name of application executable. - ``{cmd_args}`` - Array of the command line argument for the application. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_texture_format/etc2_astc: .. rst-class:: classref-property :ref:`bool` **texture_format/etc2_astc** :ref:`🔗` If ``true``, project textures are exported in the ETC2/ASTC format. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformLinuxBSD_property_texture_format/s3tc_bptc: .. rst-class:: classref-property :ref:`bool` **texture_format/s3tc_bptc** :ref:`🔗` If ``true``, project textures are exported in the S3TC/BPTC format. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`