From 8e368deef8c12d1dbce2572654c9e775691971fa Mon Sep 17 00:00:00 2001 From: Nathan Lovato Date: Wed, 28 Oct 2020 14:28:36 -0600 Subject: [PATCH] Write a page dedicated to the project manager's UI Extracted and edited the project manager from intro_to_the_editor_interface.rst, added it in the tutorials/editor section Wrote a short introduction for the editor section --- .../intro_to_the_editor_interface.rst | 69 ---------------- .../editor_ui_intro_project_manager_01.png | Bin .../editor_ui_intro_project_manager_02.png | Bin .../editor_ui_intro_project_manager_03.png | Bin .../editor_ui_intro_project_manager_04.png | Bin .../editor_ui_intro_project_manager_05.png | Bin .../editor_ui_intro_project_manager_06.png | Bin .../editor_ui_intro_project_manager_08.png | Bin .../editor_ui_intro_project_manager_09.png | Bin tutorials/editor/index.rst | 25 +++++- tutorials/editor/project_manager.rst | 75 ++++++++++++++++++ 11 files changed, 97 insertions(+), 72 deletions(-) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_01.png (100%) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_02.png (100%) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_03.png (100%) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_04.png (100%) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_05.png (100%) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_06.png (100%) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_08.png (100%) rename {getting_started/step_by_step => tutorials/editor}/img/editor_ui_intro_project_manager_09.png (100%) create mode 100644 tutorials/editor/project_manager.rst diff --git a/getting_started/step_by_step/intro_to_the_editor_interface.rst b/getting_started/step_by_step/intro_to_the_editor_interface.rst index a3148bea0..e1da79712 100644 --- a/getting_started/step_by_step/intro_to_the_editor_interface.rst +++ b/getting_started/step_by_step/intro_to_the_editor_interface.rst @@ -9,75 +9,6 @@ need to know to get started with the engine. You can `download Godot Engine here `_. -Project manager ---------------- - -When you launch Godot, the first window you'll see is the Project -Manager. Since you have no projects there will be a popup asking if you -want to open the asset library, just click cancel, we'll look at it later. - -.. image:: img/project_manager_first_open.png - -Now you should see the project manager. It lets you create, remove, import -or play game projects. - -.. image:: img/editor_ui_intro_project_manager_01.png - -In the top-right corner you'll find a drop-down menu to change the -editor's language. - -.. image:: img/editor_ui_intro_project_manager_02.png - -From the **Templates** tab you can download open source project templates and -demos from the Asset Library to help you get started faster. Just select the -template or demo you want, click download, once it's finished downloading click -install and choose where you want the project to go. You can learn more about -it in :ref:`doc_what_is_assetlib`. - -.. image:: img/editor_ui_intro_project_manager_03.png - -Create or import a project -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To create a new project, click the ``New Project`` button on the right. Here -you give it a name, choose an empty folder on your computer to save it to, -and choose a renderer. - -.. image:: img/editor_ui_intro_project_manager_04.png - -Click the Browse button to open Godot's file browser and pick a location -or type the folder's path in the Project Path field. - -.. image:: img/editor_ui_intro_project_manager_05.png - -When you see the green tick on the right, it means the engine detects an -empty folder. You can also click the ``Create Folder`` button next to your -project name and an empty folder will be created with that name for the project. - -Finally, you need to choose which renderer to use (OpenGL ES 3.0 or OpenGL -ES 2.0). The advantages and disadvantages of each are listed to help you choose, -and you can refer to :ref:`doc_gles2_gles3_differences` for more details. Note -that you can change the backend from the project settings if you change your mind -later on. For this tutorial either backend is fine. - -Once you are done click ``Create & Edit``. Godot will create -the project for you and open it in the editor. - -The next time you open the project manager, you'll see your new project in the -list. Double click on it to open it in the editor. - -.. image:: img/editor_ui_intro_project_manager_06.png - -You can import existing projects in a similar way, using the Import -button. Locate the folder that contains the project or the -``project.godot`` file to import and edit it. - -.. image:: img/editor_ui_intro_project_manager_08.png - -When the folder path is correct, you'll see a green checkmark. - -.. image:: img/editor_ui_intro_project_manager_09.png - Your first look at Godot's editor --------------------------------- diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_01.png b/tutorials/editor/img/editor_ui_intro_project_manager_01.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_01.png rename to tutorials/editor/img/editor_ui_intro_project_manager_01.png diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_02.png b/tutorials/editor/img/editor_ui_intro_project_manager_02.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_02.png rename to tutorials/editor/img/editor_ui_intro_project_manager_02.png diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_03.png b/tutorials/editor/img/editor_ui_intro_project_manager_03.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_03.png rename to tutorials/editor/img/editor_ui_intro_project_manager_03.png diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_04.png b/tutorials/editor/img/editor_ui_intro_project_manager_04.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_04.png rename to tutorials/editor/img/editor_ui_intro_project_manager_04.png diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_05.png b/tutorials/editor/img/editor_ui_intro_project_manager_05.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_05.png rename to tutorials/editor/img/editor_ui_intro_project_manager_05.png diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_06.png b/tutorials/editor/img/editor_ui_intro_project_manager_06.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_06.png rename to tutorials/editor/img/editor_ui_intro_project_manager_06.png diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_08.png b/tutorials/editor/img/editor_ui_intro_project_manager_08.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_08.png rename to tutorials/editor/img/editor_ui_intro_project_manager_08.png diff --git a/getting_started/step_by_step/img/editor_ui_intro_project_manager_09.png b/tutorials/editor/img/editor_ui_intro_project_manager_09.png similarity index 100% rename from getting_started/step_by_step/img/editor_ui_intro_project_manager_09.png rename to tutorials/editor/img/editor_ui_intro_project_manager_09.png diff --git a/tutorials/editor/index.rst b/tutorials/editor/index.rst index c80b88a90..c43bf43fa 100644 --- a/tutorials/editor/index.rst +++ b/tutorials/editor/index.rst @@ -2,14 +2,33 @@ Editor manual ============= In this section, we cover the Godot editor in general, from its interface to -using it with the command line. We cover some specific editors' interface in -other sections where appropriate. For example, the :ref:`animation editor +using it with the command line. + +The editor's interface +---------------------- + +The following pages explain how to use the various windows, workspaces, and +docks that make up the Godot editor. We cover some specific editors' interface +in other sections where appropriate. For example, the :ref:`animation editor `. +.. toctree:: + :maxdepth: 1 + :name: toc-editor-interface + + project_manager + default_key_mapping + +For developers +-------------- + +The articles below focus on features for developers, like calling Godot from the +command lines and using an external text editor such as Visual Studio Code or +Emacs. + .. toctree:: :maxdepth: 1 :name: toc-learn-editor command_line_tutorial external_editor - default_key_mapping diff --git a/tutorials/editor/project_manager.rst b/tutorials/editor/project_manager.rst new file mode 100644 index 000000000..ecadee0c2 --- /dev/null +++ b/tutorials/editor/project_manager.rst @@ -0,0 +1,75 @@ +.. _doc_project_manager: + +Using the Project manager +========================= + +When you launch Godot, the first window you see is the Project Manager. It lets +you create, remove, import, or play game projects. + +.. image:: img/editor_ui_intro_project_manager_01.png + +In the window's top-right corner, a drop-down menu allows you to change the +editor's language. + +.. image:: img/editor_ui_intro_project_manager_02.png + +Creating and importing projects +------------------------------- + +To create a new project: + +1. Click the ``New Project`` button on the right of the window. +2. Give the project a name, choose an empty folder on your computer to save the + files, and select a rendering backend. +3. Click the Create & Edit button. + +.. image:: img/editor_ui_intro_project_manager_04.png + +.. seealso:: For more information about rendering backends, see + :ref:`doc_gles2_gles3_differences`. + +Using the file browser +~~~~~~~~~~~~~~~~~~~~~~ + +Click the Browse button to open Godot's file browser and pick a location or type +the folder's path in the Project Path field. + +.. image:: img/editor_ui_intro_project_manager_05.png + +When you see the green tick on the right, it means the engine detects an empty +folder. You can also click the ``Create Folder`` button to create an empty +folder based on your project's name. + +Opening and importing projects +------------------------------ + +The next time you open the project manager, you'll see your new project in the +list. Double click on it to open it in the editor. + +.. image:: img/editor_ui_intro_project_manager_06.png + +You can similarly import existing projects using the Import button. Locate the +folder that contains the project or the ``project.godot`` file to import and +edit it. + +.. image:: img/editor_ui_intro_project_manager_08.png + +When the folder path is correct, you'll see a green checkmark. + +.. image:: img/editor_ui_intro_project_manager_09.png + +Downloading demos and templates +------------------------------- + +From the **Templates** tab you can download open source project templates and +demos from the :ref:`Asset Library ` to help you get +started faster. + +To download a demo or template: + +1. Click on its title. +2. On the page that opens, click the download button. +3. Once it finished downloading, click install and choose where you want to save + the project. + +.. image:: img/editor_ui_intro_project_manager_03.png