115 Commits

Author SHA1 Message Date
Hugo Locurcio
b27c928510 Clarify "authority" in High-level multiplayer 2024-10-04 03:56:18 +02:00
Fabio Alessandrelli
52aa5ca908 Update SSL/TLS networking tutorial (#9847)
* Update SSL/TLS networking tutorial

Swap TLS and SSL mentions (TLS is now the most widely accepted term).

Clarify that Godot now uses the trusted certifcates from the operating
system by default, and only uses the Mozilla CA bundle as a fallback.

Remove outdated export filter reference (certificates are recognized as
resources).

Warn about self-signed certificates still validating domain name when
set in project settings (and reference TLSOptions for custom behavior).

Add reference to Crypto.generate_self_signed_certificate and provide
further reference about the OpenSSL documentation.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-10-04 03:50:34 +02:00
Shawn Hardern
f975e49bd7 Add C# examples to High-level Multiplayer documentation
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2024-10-04 03:42:46 +02:00
Mateus Elias
b389d1d6ed Finish incomplete setence in High-level multiplayer tutorial (#9421)
Added clarification regarding the matching of function arguments in RPC signatures between server and client code.

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2024-08-02 02:28:03 +02:00
unknown
2afeaafa6a Update minimal websocket client example. 2024-06-05 12:45:28 -05:00
skyace65
74098ee23c Remove link to outdated networking library 2024-04-18 19:14:45 -04:00
A Thousand Ships
bd6cc665a7 Fix incorrect uses of a/an 2024-03-29 15:14:27 +01:00
Hugo Locurcio
8acfc9fa52 Update SSL/TLS certificates page for Godot 4.x
- Recommend CA certificates as the first option, as they're trusted
  by other applications and require less configuration. Let's Encrypt
  has made CA certificates available for free for a while now.
- Link to mkcert as an alternative for self-signed certificates
  (for local development purposes).
2024-03-27 19:17:47 +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
scotmcp
9d7cbfd9a0 Update high_level_multiplayer.rst (#8697)
* Update high_level_multiplayer.rst

Clarifying RPC checksum, and how all RPCs on a script must have matching partners on the target peer's script as well.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-01-13 18:26:29 +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
trflorian
297a03b2d5 replace yield with await in gd script for http client tutorial, use await instead of synchronous OS delay also on non-web platforms 2024-01-02 17:20:07 +01: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
Peter Lindgren
f64d6f51c8 Update WebRTC example code for Godot 4 (#7882)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2023-11-09 13:52:41 +01:00
Paul PINA-GHERARDI
7e573eae55 Document requirement of having client + server RPCs in High-level multiplayer (#7932)
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2023-11-09 13:30:36 +01:00
Hugo Locurcio
8e264e61e8 Add class name in classref links in Run-time file loading and saving
This is more consistent with the rest of the documentation.
2023-11-08 00:46:34 +01:00
skyace65
1ae0eff971 Fix Build issue 2023-10-02 21:19:42 -04:00
Jordyfel
49a6228d6e Patch lobby example implementation. 2023-08-21 13:10:32 +03:00
Jordyfel
2bdba37ec9 Update high level multiplayer manual for Godot 4. 2023-07-28 22:52:44 +03:00
spaceyjase
16c94c6e7c Update http_request_class.rst (#7619)
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2023-07-09 16:56:20 +02:00
Max Hilbrunner
666b55ca77 Update HTTP docs for Godot 4 2023-04-21 04:30:54 +02:00
NickCheng0921
245e8f920b Update high_level_multiplayer.rst
Old documentation used set_network_master instead of new method set_multiplayer_authority. Making this small update since rest of documentation for this page looks correct, but it took me a while to figure out why the old method wasn't working.
2023-03-24 18:40:15 -05:00
Martin Majewski
bc925e0c80 Made a sentence easier to read and included a reference to class_String (#7034)
* Excluded user created Python venv folder

* Added monospace format to code and added ref to String doc
2023-03-23 02:28:05 +01:00
Jacob Steffler
d24d85acc1 Fix a grammar mistake by adding an apostrophe 2023-03-16 19:51:08 -05:00
Patrick
1d609842dd GDExtension docs
Renames from GDNative to GDExtension


Add Pictures/Gifs and clarified compatability


Remove GDNative language bindings from GDExtension docs


Update SConstruct and AddingProperties section


updated with suggestions


Added property hint example + updated to API naming changes


Fixed redirect.csv
2023-02-26 16:44:45 +01:00
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
Yuri Sizov
9473b6c9e3 Enable error reporting on the CI and address the remaining errors 2023-02-24 17:35:32 +01:00
Raul Santos
b319da3f07 Update some C# examples for 4.0 (#6693)
* Update some C# examples

- Rename members that have been renamed in Godot's C# API for 4.0.
- Change `delta` parameter type to `double`.
- Ensure parameters match base declaration.
- Other minor code fixes.

---------

Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2023-02-04 17:03:03 +01:00
BlueStag
135ad68cab Use 4.0 method of connecting to and emitting signals (#6311)
Change docs to use the new method of connecting and emitting signals
2023-01-22 22:01:34 -05:00
Dramion
c869897350 Fix missing signal connection in code sample in Making HTTP requests (#6620) 2023-01-17 02:46:49 +01:00
Hana
9e90766a92 update c# class examples 2023-01-12 19:38:20 +01:00
Hugo Locurcio
509804650e Update all instances of instance() to instantiate() 2022-11-29 16:59:09 +01:00
Max Hilbrunner
99d3d0be12 Renames / fixes for Godot 4 2022-10-17 00:35:07 +02:00
Hugo Locurcio
d917648102 Remove mentions of VisualScript in the documentation
VisualScript has been removed in 4.0.alpha15 and later.
2022-09-01 01:44:54 +02:00
Raul Santos
3b36a94d35 Update C# signal documentation
Updates C# signal documentation and code examples to the new API in 4.0
2022-08-26 15:59:43 +02:00
David Snopek
838d03cd50 Attempt to clarify reliable vs unreliable RPCs 2022-08-02 08:49:31 -05:00
Nathan Anderson
aca8507c92 Mention WebRTC support on HTML5 in High-level multiplayer (#5937)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-07-16 18:36:29 +02:00
Fabio Alessandrelli
fd0d712814 [Net] Change server in the websocket demo.
The old server (echo.websocket.org) is no longer active.
The new server (libwebsockets.org) is the demo server of another popular
websocket library (LWS) which we also previously used.
2022-04-29 13:44:48 +02:00
Will Stott
1ac9f5ec31 Update the websockets tutorial for Godot 4's new signal connect syntax. (#5776) 2022-04-29 12:26:29 +02:00
Henodude
deb89f665d Fix the syntax for the Android permission requirement on network tutorials (#5433) 2021-12-06 18:13:15 +01:00
Lucida Dragon
062aa06eec Fix typo in WebSocket tutorial (#5296) 2021-10-04 01:40:12 +02:00
Aaron Franke
5c7f653347 Optimize PNG and SVG images using oxipng and svgcleaner (#5254) 2021-09-14 17:50:17 +02:00
luzpaz
d9bc787dd9 Fix various typos (#5215)
Fix various typos

Found via `codespell -q 3 -S ./LICENSE.txt -L doubleclick,findn,lod,inout,nd,raison,te`
2021-09-02 17:02:23 +03:00
Hugo Locurcio
17c5fe0e35 Document the permission requirement on Android on network tutorials 2021-08-11 18:15:28 +02:00
Marcin Sędłak-Jakubowski
bd19917ea0 Draft: Remove "simple", "simply", "easy", and "just" from the docs (#4496)
* Various style edits

* Edit out "simple" when possible

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Clay John <claynjohn@gmail.com>
2021-07-11 14:38:53 +02:00
Rodrigo Ceccato de Freitas
32bb9315e0 Fix small typo 2021-06-12 18:26:37 -03:00
Rémi Verschelde
044b6a74f8 Cleanup uses of double spaces between words or after punctuation 2021-06-07 10:44:02 +02:00
Rémi Verschelde
2d710ef15e Merge pull request #4462 from TechnoPorg/master
Add C# code examples for HTTPClient and HTTPRequest
2021-03-19 13:19:24 +01:00
Divided by Zer0
36c9302533 Adjust HTTPClient example code to not break in HTML5 exports (#4738)
Fixes godotengine/godot#46857

Added supported wait periods after poll() for HTML5
This prevents warning about multiple polls in the same frame
and prevent hanging the game when fetching the body chunks
2021-03-11 12:14:44 +01:00
TechnoPorg
8d78a46f0d Add C# code examples for HTTPClient and HTTPRequest
Ported the existing GDScript code examples to C# for both HTTPClient and HTTPRequest.
2021-01-19 15:17:51 -07:00