godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4335 from Calinou/improve-one-click-deploy-2

Browse Source 
Improve the one-click deploy page
This commit is contained in:
Nathan Lovato
2020-11-27 16:03:43 -06:00
committed by GitHub
parent 62a3ef6c51 ad05a65414
commit 907df88549
1 changed files with 48 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
tutorials/export/one-click_deploy.rst
View File

@@ -3,29 +3,57 @@
One-click deploy
================
Sounds good, what is it?
------------------------
What is one-click deploy?
-------------------------
This feature will pop up automatically once a platform is properly configured
and a supported device is connected to the computer. Since things can go wrong
at many levels (platform may not be configured correctly, SDK may be incorrectly
installed, device may be improperly configured, etc.), it's good to let the user
know that it exists.
One-click deploy is a feature that is available once a platform is properly
configured and a supported device is connected to the computer. Since things can
go wrong at many levels (platform may not be configured correctly, SDK may be
incorrectly installed, device may be improperly configured, etc.), it's good to
let the user know that it exists.
Some platforms (at the time of this writing, only Android) can detect when a USB
device is connected to the computer, and offer the user to automatically export,
install and run the project (in debug mode) on the device. This feature is
called, in industry buzzwords, "One-Click Deploy".
After adding an Android export preset marked as Runnable, Godot can detect when
a USB device is connected to the computer and offer the user to automatically
export, install and run the project (in debug mode) on the device. This feature
is called *one-click deploy*.
Steps for one-click deploy
--------------------------
.. note::
#. Configure target platform.
#. Configure device (make sure it's in developer mode, likes the
computer, USB cable is plugged, USB is recognized, etc.).
#. Connect the device...
#. And voilà!
One-click deploy is only available once you've added an export template
marked as **Runnable** in the Export dialog. You can mark several export
presets as runnable, but only one preset per platform may be marked as
runnable. If you mark a second preset in a given platform as runnable, the
other preset will no longer be marked as runnable.
Supported platforms
-------------------
- **Android:** Exports the project with debugging enabled and runs it on the
connected device.
- Make sure to follow the steps described in :ref:`doc_exporting_for_android`.
Otherwise, the one-click deploy button won't appear.
- If you have more than one device connected, Godot will ask you which device
the project should be exported to.
- **HTML5:** Starts a local web server and runs the exported project by opening
the default web browser.
Support for more platforms such as iOS is planned.
Using one-click deploy
----------------------
- If deploying to Android, enable developer mode on the your mobile device then
connect the device to your PC using an USB cable.
- For advanced users, it should also be possible to use wireless ADB.
- Make sure there is an export preset marked as **Runnable** for the target
platform (Android or HTML5).
- If everything is configured correctly and with no errors, platform-specific
icons will appear in the top-right corner of the editor.
- Click the button to export to the desired platform in one click.
.. image:: img/oneclick.png
Click once... and deploy!