Commit Graph

1434 Commits

Author SHA1 Message Date
Matthew
855fb288d0 Merge pull request #8699 from BenAmundson/patch-2
Update 05.spawning_mobs.rst (typo regarding 'respectively')
2024-01-16 21:38:41 -05:00
Max Hilbrunner
ae8ef84602 Merge pull request #8721 from FishingSimulator/patch-1
Update "The Main Game Scene" for clarity
2024-01-14 00:27:03 +01:00
Max Hilbrunner
01a7b2ff94 Merge pull request #7520 from Calinou/add-page-comments
Add support for user-provided comments with Giscus
2024-01-13 22:32:30 +01:00
Max Hilbrunner
e624ab525c Merge pull request #8705 from eztaah/master
Fix incorrect instruction to call node during 2D tutorial
2024-01-13 18:12:30 +01:00
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00
Adam Johnston
d4bff01d23 Add c# script name note to scripting_first_script.rst 2024-01-06 16:56:22 -08:00
FishingSimulator
1f1f3674ab Update "The Main Game Scene" for clarity
Many people have reported having issues connecting HUD's start_game and the main node's new_game() in the next step of this tutorial. This occurred for me because the documentation states that "new_game()" should be removed from the _ready() function, but does not include instructions to add "pass" back (and pass is not left in the example code when "new_game()" is added to the function, so the initial one will not remain). Having the function declaration without "pass" breaks all the following functions, preventing new_game() (or any Main functions) from being connected.
2024-01-05 14:58:44 +11:00
eztaah
5e94876c4f Reorder instructions in 06.heads_up_display.rst 2024-01-03 11:15:41 +01:00
eztaah
10ffe56d43 Fix incorrect instruction to call node during 2D tutorial 2024-01-02 13:51:00 +01:00
Max Hilbrunner
6a731a6c7a Merge pull request #8693 from brentruhle/patch-2
Adding missing MacOS commands
2024-01-02 08:43:34 +01:00
Benjamin Amundson
c243b307a9 Update 05.spawning_mobs.rst (typo regarding 'respectively')
The order of mentioned nodes (SpawnPath and SpawnLocation) does not match the previous sentence when using "respectively". The following image confirms the order may be backwards.
2024-01-01 16:04:02 -05:00
Brent Ruhle
da2c56c1bc Adding missing MacOS commands
Singular instance of the the F5 build command not having it's corresponding MacOS shortcut equivalent.
2024-01-01 12:06:01 +01:00
Brent Ruhle
099a519df4 Verified step by step index is up to date
Reviewed the documentation on the main index page of step by step and have verified it is up to date. Setting article outdated flag to false.
2023-12-30 15:21:59 -05:00
Vlad Rakhmanin
59336ef39a Fixes grammatical error in 'Creating the Enemy'
The existing text reads "Select the Mob node and set it's Gravity Scale..."

It is instead grammatically correct to say "and set its" without an apostrophe.
2023-12-10 10:12:16 +00:00
Max Hilbrunner
d06f0a0e83 Merge pull request #8557 from Piralein/input-mapping
Your first 2D game - Finishing up: Add image for input map setup clarification
2023-12-04 15:11:48 +01:00
Stevoisiak
c674d43c2b First 2D Game - Link directly to Creeps source code
Changes a hyperlink In the tutorial for Your First 2D game, Dodge the Creeps, to link directly to the Dodge the Creeps folder of the Godot demo projects page instead of the main repository page that contains multiple games.
2023-12-03 11:38:20 +01:00
Matthew
ba3973db19 Merge pull request #8418 from a2937/fix/use-consistent-script-name
fix : use the earlier name of the player input script
2023-12-02 07:52:19 -05:00
Hana - Piralein
d83330fd11 Update image with snake case file name 2023-12-02 13:07:40 +01:00
Hana - Piralein
8234345608 Add image for clarification 2023-12-02 12:49:17 +01:00
Matthew
d9725deef6 Merge pull request #8466 from theDrake/patch-1
Minor edits for scripting_player_input.rst
2023-11-28 21:15:43 -05:00
Guerric Haché
217bd3c066 Updating the 2D tutorial in light of an editor bug (#7915)
* Update to the 2D tutorial

Issue #41283 is currently disrupting the flow of the official 2D tutorial for folks with external script editors.

This change is to update the tutorial to acknowledge this bug and provide newcomers with clearer guidelines on how to complete the tutorial despite the bug.

It also clarifies a potential point of confusion about how the editor communicates connection between signals and script functions.

Co-authored-by: Matthew <matthewehr@hotmail.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-11-24 16:29:50 -05:00
Matthew
7606b7c781 Merge pull request #8113 from mediacloner/mediacloner-patch-1
Update 04.creating_the_enemy.rst
2023-11-24 15:16:32 -05:00
Matthew
913b20b826 Merge pull request #7983 from MeLight/getting-started-inst-4.1
Step by Step - Instancing 4.1 update
2023-11-24 12:44:58 -05:00
Matthew
ee1fe1caea Merge pull request #8462 from theDrake/patch-2
Adjust comma placement in 01.project_setup.rst
2023-11-20 19:07:37 -05:00
David C. Drake
f84168db6a Adjust comma placement in 01.project_setup.rst
Changed "window and in the left column," to "window, in the left column".
2023-11-19 11:54:19 -07:00
David C. Drake
83bc0c5e97 "as long" -> "as long as" in 03.player_movement_code.rst
Changed "as long it is not on or collides" to "as long as it is not on or colliding".
2023-11-17 20:49:38 -07:00
René van der Ark
4ada3f63a6 Fixes typo in reference to normalized method. 2023-11-17 16:39:22 +01:00
Max Hilbrunner
9aba4a087a Merge pull request #8467 from Calinou/remove-unused-images
Remove unused images
2023-11-15 07:10:03 +01:00
CHM
e2f9034f8d Remove outdated C++ tutorial in "Your first 2D game" 2023-11-14 23:00:33 +08:00
Hugo Locurcio
f9817954c7 Remove unused images
This reduces the size of ZIP downloads for offline reading.

Unused images were found by running `_tools/list-unused-images.sh`.
These images were used in Godot 2.x and 3.x documentation,
but have been replaced by remade images with different names since.
2023-11-13 21:57:19 +01:00
David C. Drake
c274df34d9 Minor edits for scripting_player_input.rst
Added two commas before lesson titles and changed "properties like" to "properties, such as".
2023-11-13 12:04:12 -07:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Max Hilbrunner
66b59c1896 Merge pull request #8437 from Piralein/moreorlessorwarning
Remove the remaining reminder and add it as a warning (Your first 2D game - Heads up display)
2023-11-10 06:12:21 +01:00
Matthew
e760a9f18b Merge pull request #7934 from RayFV/patch-1
Fixed macOS shortcut
2023-11-09 21:02:21 -05:00
Hana - Piralein
a24b42c366 Add the reminder as warning 2023-11-09 19:34:53 +01:00
FelixBurkhard
d99a88235c Fix minor issues in Your first 2D game (#8129)
- The `Dodge the Creeps!` string was not consistent through the page.
- The `\n` was removed from the Label Text because the Label should do the wrapping.
- There were two reminders to remove the `new_game()` call with only a few lines in between.
2023-11-09 13:42:32 +01:00
Carl Meyer
8e18efa328 Mark Instancing tutorial as up-to-date (#8146)
I could follow it without any issues on 4.1.
2023-11-09 12:55:28 +01:00
Jackie Xu
8625ccb362 Fix duplicate mob squash logic in Your first 3D game (#7767) 2023-11-09 11:12:02 +01:00
Max Hilbrunner
e83fd34f10 Merge pull request #8430 from skyace65/FirstScript
Update images on first script page
2023-11-09 08:29:51 +01:00
David C. Drake
81be1460d5 Minor fixes in scripting_first_script.rst (#8415)
* Minor fixes in scripting_first_script.rst

Changed "by default" to "at their default values" and "calling the rotated() method on any Vector2" to "calling the Vector2 method rotated()" (in context, these changes are correct). Also added a missing comma.

* "at" -> "set to" in scripting_first_script.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-11-08 21:07:17 -05:00
Matthew
2678909bdb Merge pull request #8414 from theDrake/patch-1
Add missing comma in instancing.rst
2023-11-08 21:05:19 -05:00
skyace65
36f035d62b Update images on first script page 2023-11-08 20:59:44 -05:00
Max Hilbrunner
0de25a60c4 Merge pull request #8413 from Calinou/fix-unused-images
Fix various cases of unused images
2023-11-08 07:36:10 +01:00
Matthew
7acbeb9c88 Merge pull request #8349 from catslanderer/patch-2
Update scripting_player_input.rst
2023-11-07 21:36:15 -05:00
Aaron
09d38572cf Fix: Use the earlier name of the script. 2023-11-07 17:20:05 -05:00
David C. Drake
174c02df04 Add missing comma in instancing.rst
I added a comma after 'blueprint' in this sentence: "Instancing, the process of producing an object from a blueprint, has many handy uses."
2023-11-07 10:43:08 -07:00
Hugo Locurcio
071d49a489 Fix various cases of unused images
Some of these images were duplicates or not relevant anymore,
so they have been removed entirely. Others have had their links fixed
or added where relevant.
2023-11-07 18:04:26 +01:00
Max Hilbrunner
3b9cb26da3 Merge pull request #8388 from Calinou/gdextension-update-references
Update references to community GDExtensions to point to up-to-date resources
2023-11-05 17:17:23 +01:00
David C. Drake
ca72a1c9aa Remove extra "the" in nodes_and_scenes.rst
Current text is "see the The Inspector" (because the header for `doc_editor_inspector_dock` is "The Inspector"), so I removed the extraneous "the".
2023-11-04 17:17:56 -06:00
Hugo Locurcio
76bfb6e713 Update references to community GDExtensions to point to up-to-date resources 2023-11-03 19:21:25 +01:00