Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move tutorial ZIPs to a dedicated repository #7222

Merged
merged 1 commit into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions contributing/documentation/contributing_to_the_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <files/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 <files/file_name.zip>`

Consider using the `godot-docs-project-starters <https://github.com/godotengine/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 <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/file_name.zip>`_


License
Expand Down
4 changes: 2 additions & 2 deletions getting_started/first_2d_game/01.project_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ Launch Godot and create a new project.
.. tabs::
.. tab:: GDScript

Download :download:`dodge_assets.zip <files/dodge_assets.zip>`.
Download `dodge_the_creeps_2d_assets.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/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 <files/dodge_assets.zip>`.
Download `dodge_the_creeps_2d_assets.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/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.
Expand Down
Binary file removed getting_started/first_2d_game/files/dodge_assets.zip
Binary file not shown.
4 changes: 2 additions & 2 deletions getting_started/first_2d_game/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -57,7 +57,7 @@ the code.

You can download them by clicking the link below.

:download:`dodge_assets.zip <files/dodge_assets.zip>`.
`dodge_the_creeps_2d_assets.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/dodge_the_creeps_2d_assets.zip>`_.

Contents
--------
Expand Down
Binary file removed getting_started/step_by_step/files/instancing.zip
Binary file not shown.
Binary file removed getting_started/step_by_step/files/pong_assets.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion getting_started/step_by_step/instancing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <files/instancing.zip>`.
`instancing_starter.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/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)
Expand Down
2 changes: 1 addition & 1 deletion tutorials/2d/2d_movement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <files/2D_movement_demo.zip>`
`2d_movement_starter.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/2d_movement_starter.zip>`_
2 changes: 1 addition & 1 deletion tutorials/2d/2d_sprite_animation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ animation:
.. image:: img/2d_animation_run_preview.gif

You can download the images here:
:download:`run_animation.zip <files/run_animation.zip>`
`2d_sprite_animation_assets.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/2d_sprite_animation_assets.zip>`_

Unzip the images and place them in your project folder. Set up your scene tree
with the following nodes:
Expand Down
Binary file removed tutorials/2d/files/2D_movement_demo.zip
Binary file not shown.
Binary file removed tutorials/2d/files/run_animation.zip
Binary file not shown.
Binary file removed tutorials/3d/files/gridmap_demo.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion tutorials/3d/using_gridmaps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Example project
---------------

To learn how GridMaps work, start by downloading the sample project:
:download:`gridmap_demo.zip <files/gridmap_demo.zip>`.
`gridmap_starter.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/gridmap_starter.zip>`_.

Unzip this project and add it to the Project Manager using the "Import"
button.
Expand Down
3 changes: 2 additions & 1 deletion tutorials/animation/cutout_animation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ character, created by Andreas Esau.

.. image:: img/tuto_cutout_walk.gif

Get your assets: :download:`gbot_resources.zip <files/gbot_resources.zip>`.
Get your assets:
`cutout_animation_assets.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/cutout_animation_assets.zip>`_.

Setting up the rig
~~~~~~~~~~~~~~~~~~
Expand Down
Binary file removed tutorials/animation/files/gbot_resources.zip
Binary file not shown.
Binary file removed tutorials/physics/files/kbscene.zip
Binary file not shown.
Binary file removed tutorials/physics/files/using_area_2d.zip
Binary file not shown.
Binary file removed tutorials/physics/files/using_kinematic2d.zip
Binary file not shown.
5 changes: 3 additions & 2 deletions tutorials/physics/kinematic_character_2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,9 @@ Scene setup
~~~~~~~~~~~

To have something to test, here's the scene (from the tilemap tutorial):
:download:`kbscene.zip <files/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 <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/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

Expand Down
2 changes: 1 addition & 1 deletion tutorials/physics/using_area_2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ override.
.. image:: img/area2d_override.gif

You can download this project here:
:download:`using_area_2d.zip <files/using_area_2d.zip>`
`area_2d_starter.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/area_2d_starter.zip>`_
2 changes: 1 addition & 1 deletion tutorials/physics/using_character_body_2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Examples
--------

To see these examples in action, download the sample project:
:download:`using_kinematic2d.zip <files/using_kinematic2d.zip>`.
`character_body_2d_starter.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/character_body_2d_starter.zip>`_

Movement and walls
~~~~~~~~~~~~~~~~~~
Expand Down
Binary file removed tutorials/scripting/files/autoload.zip
Binary file not shown.
3 changes: 2 additions & 1 deletion tutorials/scripting/singletons_autoload.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <files/autoload.zip>` and open it in Godot.
`singleton_autoload_starter.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/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
Expand Down