diff --git a/contributing/documentation/contributing_to_the_documentation.rst b/contributing/documentation/contributing_to_the_documentation.rst index de02b18c8..b43ff354a 100644 --- a/contributing/documentation/contributing_to_the_documentation.rst +++ b/contributing/documentation/contributing_to_the_documentation.rst @@ -165,15 +165,31 @@ a meaningful name and include them in your page with: .. code:: rst - .. image:: img/image_name.png + .. image:: img/image_name.webp -Similarly, you can include attachments, like assets as support material for a -tutorial, by placing them into a ``files/`` folder next to the ``.rst`` file, and -using this inline markup: +Alternatively, you can use the `figure` directive, which gives the image a contrasting +border and allows centering it on the page. .. code:: rst - :download:`myfilename.zip ` + .. figure:: img/image_name.webp + :align: center + +You can also include attachments as support material for a tutorial, by placing them +into a ``files/`` folder next to the ``.rst`` file, and using this inline markup: + +.. code:: rst + + :download:`file_name.zip ` + +Consider using the `godot-docs-project-starters ` +repository for hosting support materials, such as project templates and asset packs. +You can use a direct link to the generated archive from that repository with the regular +link markup: + +.. code:: rst + + `file_name.zip `_ License diff --git a/getting_started/first_2d_game/01.project_setup.rst b/getting_started/first_2d_game/01.project_setup.rst index 78c3e42f8..e2b441572 100644 --- a/getting_started/first_2d_game/01.project_setup.rst +++ b/getting_started/first_2d_game/01.project_setup.rst @@ -12,14 +12,14 @@ Launch Godot and create a new project. .. tabs:: .. tab:: GDScript - Download :download:`dodge_assets.zip `. + Download `dodge_the_creeps_2d_assets.zip `_. The archive contains the images and sounds you'll be using to make the game. Extract the archive and move the ``art/`` and ``fonts/`` directories to your project's directory. .. tab:: C# - Download :download:`dodge_assets.zip `. + Download `dodge_the_creeps_2d_assets.zip `_. The archive contains the images and sounds you'll be using to make the game. Extract the archive and move the ``art/`` and ``fonts/`` directories to your project's directory. diff --git a/getting_started/first_2d_game/files/dodge_assets.zip b/getting_started/first_2d_game/files/dodge_assets.zip deleted file mode 100644 index eb9c5a9df..000000000 Binary files a/getting_started/first_2d_game/files/dodge_assets.zip and /dev/null differ diff --git a/getting_started/first_2d_game/index.rst b/getting_started/first_2d_game/index.rst index a92ad8560..b52590932 100644 --- a/getting_started/first_2d_game/index.rst +++ b/getting_started/first_2d_game/index.rst @@ -17,7 +17,7 @@ a 2D game. programming entirely, you should start here: :ref:`doc_scripting`. The game is called "Dodge the Creeps!". Your character must move and avoid the -enemies for as long as possible. +enemies for as long as possible. You will learn to: @@ -57,7 +57,7 @@ the code. You can download them by clicking the link below. -:download:`dodge_assets.zip `. +`dodge_the_creeps_2d_assets.zip `_. Contents -------- diff --git a/getting_started/step_by_step/files/instancing.zip b/getting_started/step_by_step/files/instancing.zip deleted file mode 100644 index 0b8abefff..000000000 Binary files a/getting_started/step_by_step/files/instancing.zip and /dev/null differ diff --git a/getting_started/step_by_step/files/pong_assets.zip b/getting_started/step_by_step/files/pong_assets.zip deleted file mode 100644 index eb6451aca..000000000 Binary files a/getting_started/step_by_step/files/pong_assets.zip and /dev/null differ diff --git a/getting_started/step_by_step/instancing.rst b/getting_started/step_by_step/instancing.rst index cc13849f3..a4d3b020a 100644 --- a/getting_started/step_by_step/instancing.rst +++ b/getting_started/step_by_step/instancing.rst @@ -42,7 +42,7 @@ In practice Let's use instancing in practice to see how it works in Godot. We invite you to download the ball's sample project we prepared for you: -:download:`instancing.zip `. +`instancing_starter.zip `_. Extract the archive on your computer. To import it, you need the Project Manager. The Project Manager is accessed by opening Godot, or if you already have Godot opened, click on *Project -> Quit to Project List* (:kbd:`Ctrl + Shift + Q`, :kbd:`Ctrl + Option + Cmd + B` on macOS) diff --git a/tutorials/2d/2d_movement.rst b/tutorials/2d/2d_movement.rst index b164e024f..6d02e5a9f 100644 --- a/tutorials/2d/2d_movement.rst +++ b/tutorials/2d/2d_movement.rst @@ -289,4 +289,4 @@ You may find these code samples useful as starting points for your own projects. Feel free to use them and experiment with them to see what you can make. You can download this sample project here: -:download:`2D_movement_demo.zip ` +`2d_movement_starter.zip `_ diff --git a/tutorials/2d/2d_sprite_animation.rst b/tutorials/2d/2d_sprite_animation.rst index 0c6e427a9..7ec138595 100644 --- a/tutorials/2d/2d_sprite_animation.rst +++ b/tutorials/2d/2d_sprite_animation.rst @@ -28,7 +28,7 @@ animation: .. image:: img/2d_animation_run_preview.gif You can download the images here: -:download:`run_animation.zip ` +`2d_sprite_animation_assets.zip `_ Unzip the images and place them in your project folder. Set up your scene tree with the following nodes: diff --git a/tutorials/2d/files/2D_movement_demo.zip b/tutorials/2d/files/2D_movement_demo.zip deleted file mode 100644 index 120975c9e..000000000 Binary files a/tutorials/2d/files/2D_movement_demo.zip and /dev/null differ diff --git a/tutorials/2d/files/run_animation.zip b/tutorials/2d/files/run_animation.zip deleted file mode 100644 index 3fc00f582..000000000 Binary files a/tutorials/2d/files/run_animation.zip and /dev/null differ diff --git a/tutorials/3d/files/gridmap_demo.zip b/tutorials/3d/files/gridmap_demo.zip deleted file mode 100644 index e95301a7f..000000000 Binary files a/tutorials/3d/files/gridmap_demo.zip and /dev/null differ diff --git a/tutorials/3d/using_gridmaps.rst b/tutorials/3d/using_gridmaps.rst index fce9d221c..cd019b73e 100644 --- a/tutorials/3d/using_gridmaps.rst +++ b/tutorials/3d/using_gridmaps.rst @@ -19,7 +19,7 @@ Example project --------------- To learn how GridMaps work, start by downloading the sample project: -:download:`gridmap_demo.zip `. +`gridmap_starter.zip `_. Unzip this project and add it to the Project Manager using the "Import" button. diff --git a/tutorials/animation/cutout_animation.rst b/tutorials/animation/cutout_animation.rst index 00c5dedea..6d1d35e3e 100644 --- a/tutorials/animation/cutout_animation.rst +++ b/tutorials/animation/cutout_animation.rst @@ -59,7 +59,8 @@ character, created by Andreas Esau. .. image:: img/tuto_cutout_walk.gif -Get your assets: :download:`gbot_resources.zip `. +Get your assets: +`cutout_animation_assets.zip `_. Setting up the rig ~~~~~~~~~~~~~~~~~~ diff --git a/tutorials/animation/files/gbot_resources.zip b/tutorials/animation/files/gbot_resources.zip deleted file mode 100644 index 3b00024c3..000000000 Binary files a/tutorials/animation/files/gbot_resources.zip and /dev/null differ diff --git a/tutorials/physics/files/kbscene.zip b/tutorials/physics/files/kbscene.zip deleted file mode 100644 index df063ae2e..000000000 Binary files a/tutorials/physics/files/kbscene.zip and /dev/null differ diff --git a/tutorials/physics/files/using_area_2d.zip b/tutorials/physics/files/using_area_2d.zip deleted file mode 100644 index f69bec2a8..000000000 Binary files a/tutorials/physics/files/using_area_2d.zip and /dev/null differ diff --git a/tutorials/physics/files/using_kinematic2d.zip b/tutorials/physics/files/using_kinematic2d.zip deleted file mode 100644 index 55a50a0c7..000000000 Binary files a/tutorials/physics/files/using_kinematic2d.zip and /dev/null differ diff --git a/tutorials/physics/kinematic_character_2d.rst b/tutorials/physics/kinematic_character_2d.rst index 4894b6264..e5310f906 100644 --- a/tutorials/physics/kinematic_character_2d.rst +++ b/tutorials/physics/kinematic_character_2d.rst @@ -77,8 +77,9 @@ Scene setup ~~~~~~~~~~~ To have something to test, here's the scene (from the tilemap tutorial): -:download:`kbscene.zip `. We'll be creating a new scene -for the character. Use the robot sprite and create a scene like this: +`kinematic_character_2d_starter.zip `_. +We'll be creating a new scene for the character. Use the robot sprite and +create a scene like this: .. image:: img/kbscene.png diff --git a/tutorials/physics/using_area_2d.rst b/tutorials/physics/using_area_2d.rst index d338864dc..08940cccb 100644 --- a/tutorials/physics/using_area_2d.rst +++ b/tutorials/physics/using_area_2d.rst @@ -139,4 +139,4 @@ override. .. image:: img/area2d_override.gif You can download this project here: -:download:`using_area_2d.zip ` +`area_2d_starter.zip `_ diff --git a/tutorials/physics/using_character_body_2d.rst b/tutorials/physics/using_character_body_2d.rst index dd30c54ec..b8f312f8e 100644 --- a/tutorials/physics/using_character_body_2d.rst +++ b/tutorials/physics/using_character_body_2d.rst @@ -218,7 +218,7 @@ Examples -------- To see these examples in action, download the sample project: -:download:`using_kinematic2d.zip `. +`character_body_2d_starter.zip `_ Movement and walls ~~~~~~~~~~~~~~~~~~ diff --git a/tutorials/scripting/files/autoload.zip b/tutorials/scripting/files/autoload.zip deleted file mode 100644 index 5cef0f04e..000000000 Binary files a/tutorials/scripting/files/autoload.zip and /dev/null differ diff --git a/tutorials/scripting/singletons_autoload.rst b/tutorials/scripting/singletons_autoload.rst index ae44e19ee..2d2c9a00e 100644 --- a/tutorials/scripting/singletons_autoload.rst +++ b/tutorials/scripting/singletons_autoload.rst @@ -120,7 +120,8 @@ method (see :ref:`doc_scene_tree` for details). However, if you need more complex behavior when changing scenes, this method provides more functionality. To begin, download the template from here: -:download:`autoload.zip ` and open it in Godot. +`singleton_autoload_starter.zip `_ +and open it in Godot. The project contains two scenes: ``Scene1.tscn`` and ``Scene2.tscn``. Each scene contains a label displaying the scene name and a button with its