Commit Graph

48 Commits

Author SHA1 Message Date
Quentin Quaadgras
7e194152d5 Add Go to the list of community maintained GDExtension bindings. (#8808)
* Add Go to the list of community maintained bindings.

---------

Co-authored-by: Raul Santos <raulsntos@gmail.com>
2024-01-23 18:20:15 +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
PgBiel
1826557b43 Update link to Rust GDExtension bindings 2023-12-29 09:29:29 -03:00
pseidemann
067170fb8b add missing override modifier for _process() 2023-11-19 15:31:44 +01:00
Hugo Locurcio
59cfbbbd82 Add notice about GDExtension being experimental in What is GDExtension? 2023-11-17 15:28:45 +01:00
Hugo Locurcio
8f963d91e8 Improve GDExtension documentation
- Mention additional language bindings that support 4.x (already listed
  on the FAQ and List of features pages).
- Document compatibility issues with double-precision builds.
- Remove `-j4` flag from example as SCons uses most CPU cores
  automatically by default in godot-cpp now.
2023-11-07 14:42:44 +01:00
Zacrain
5110c2dda8 Fix GDExample C++ signal connect example and add explanation (#8381)
* Fix signal connect example, add explanation

* Update tutorials/scripting/gdextension/gdextension_cpp_example.rst

Co-authored-by: David Snopek <dsnopek@gmail.com>

* Update tutorials/scripting/gdextension/gdextension_cpp_example.rst

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: David Snopek <dsnopek@gmail.com>
2023-11-03 02:24:20 +01:00
Max Hilbrunner
796df85fce Merge pull request #8084 from bferguson3/master
Update gdextension_cpp_example.rst (Clarification rwt dump extension API)
2023-10-21 21:26:02 +02:00
Max Hilbrunner
95869e42ff Merge pull request #8153 from Repiteo/space-to-tab-v2
Automatically convert spaces to tabs in CodeBlocks
2023-10-06 12:50:53 +02:00
Thaddeus Crews
acf09b8551 Automatically convert spaces to tabs in codeblocks
• Adds codeblock css rule for tab-size
• Only applies to GDScript/C++
• Fix some inconsistent cpp codeblock filters
2023-10-05 19:04:26 -05:00
TheBlckbird
4175ccd451 Add Swift to what_is_gdextension.rst 2023-09-29 08:56:29 +02:00
bferguson3
539a63a2b0 Update gdextension_cpp_example.rst
Removed unused filename parameter from --dump-extension-api command in GDExtension tutorial and clarified language after.
2023-09-28 13:01:59 -04:00
Luna
0fe7ff833e Fixed typos in several doc files (#8002)
* Fixed typos in
- c_sharp_differences.rst
- debugger_panel.rst
- gdextension_cpp_example.rst
- gui_using_fonts.rst
- openxr_hand_tracking.rst
- overview_of_debugging_tools.rst
- setting_up_xr.rst
- shading_language.rst
- the_profiler.rst
- your_second_3d_shader.rst

* Update tutorials/shaders/shader_reference/shading_language.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

* PR Feedback

---------

Co-authored-by: Luna <2650849-Lunalicious@users.noreply.gitlab.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-09-25 00:41:33 +02:00
Yuri Rubinsky
69c25552bc Fix typo in gdextension_cpp_example.rst 2023-09-23 10:25:45 +03:00
Yuri Rubinsky
7119fa1cfb Fix register_types.h code in GDExtension example 2023-09-23 10:11:56 +03:00
Max Hilbrunner
8f4347e2a5 Merge pull request #7865 from dashdotdashdot/patch-1
Update gdextension_cpp_example.rst to avoid unquoted compatibility_minimum trap
2023-09-13 04:12:27 +02:00
Noctor Onwood
306b24246b Custom editor icon section's command wrong or out of date.
In the "*.gdextension" code block, the [Icon] tag does not work in 4.1.1.stable version, and it does not match the naming conventions of other tags. I test it, [icons] tag is worked well. In addition, I added a blank lines between the tag and the content to make it more consistent with other "*.gdextension" code block formatting.

Update with capnm's suggestion. Thank you all for your attention and reply!
2023-09-02 23:03:29 +08:00
dashdotdashdot
0583b2b6b6 Enclose .gdextension's compatibility_minimum in quotes to avoid parse errors if extended to unquoted x.y.z format.
Fixes #7864
2023-08-31 19:00:53 +09:00
Max Hilbrunner
31ac9bc227 Merge pull request #7699 from dsnopek/gdextension-4.1-notes 2023-07-22 17:17:07 +02:00
Patrick
b14b5c8166 Add request to report missing exposed GDExtension funcationality
* adds note to the "What is GDExtension" docs to call for issue creation when people can't do something in GDExtension that is possible with modules
2023-07-21 22:02:25 +02:00
David Snopek
5c99fd3eaa Update GDExtension C++ tutorial to explain compatibility and point out Godot 4.1 breakage 2023-07-20 09:32:29 -05:00
Max Hilbrunner
a34243c85d Merge pull request #7461 from Jackerty/GDExtension 2023-07-18 14:06:27 +02:00
Max Hilbrunner
fd773620ff Merge pull request #7595 from catwasd/catwasd/fix-typos 2023-07-18 13:27:43 +02:00
Hugo Locurcio
df904137db Fix incorrect usage of backticks in various pages 2023-07-14 19:31:01 +02:00
Patrick
a9ab043f08 Update GDExtension docs with 4.1 branch info 2023-07-12 23:11:46 +02:00
Junhao Wang
7499e7b774 Fix initialization typos in GDExtension manual 2023-07-01 11:34:05 -07:00
Max Hilbrunner
efe99c2974 Merge pull request #7491 from paddy-exe/clarify-gdextension-master 2023-06-09 21:41:26 +02:00
Patrick
9704d2928e Set godot-cpp branch to 4.0 in GDExtension tutorial 2023-06-09 20:44:49 +02:00
Patrick
7961a18087 Fixes typos in GDExtension tutorial 2023-06-09 20:30:04 +02:00
Jackerty
1487caec8d Mentioning the GDExtension icon support
A node that is loaded through GDExtension can have a custom icon. Icon's path can be added via the `gdextension` file.
(See https://github.com/godotengine/godot/pull/75472).

Commit makes a mention of this in the C++ tutorial.
2023-06-08 19:12:02 +03:00
Leonid V. Fedorenchik
b3f0c96ed3 Fix code typos
* change parameter name to p_amplitude
* add const to get_speed()
2023-05-21 12:12:35 +08:00
Patrick
37c50b1909 Update GDExtension tutorial for entry functions
Docs part of https://github.com/godotengine/godot-cpp/pull/1095
Same changes as https://github.com/godotengine/godot-cpp/pull/1115
2023-05-19 11:32:59 +02:00
Max Hilbrunner
9caad0c5e4 Merge pull request #7308 from Yunusemre-Oeztuerk/patch-1 2023-05-15 01:16:42 +02:00
Yunusemre-Oeztuerk
c535fc7b1d gdexample.gdextension file not recognized
Using Windows 10 and Godot 4.0.2 Mono

The gdexample.gdextension file used in the example project is not being recognized by my version of Godot. I don't know the exact reason but I'm guessing it is because it doesn't specify whether or not it is supposed to be a debug or release file.

My changed .gdextension file is the same as the one that is available under godot-cpp\test\demo\example.gdextension. With this one it worked with no problems.
2023-05-08 14:54:23 +02:00
Yunusemre-Oeztuerk
c6d224c4ea Error in gdexample.cpp
When adding the getter and setter functions to the example project a void has been added to the constructor in line 439 which was previously not there (in line 213) and is also causing the error C2533: constructors not allowed a return type. Simply removing it again fixes it.
2023-05-08 14:42:15 +02:00
Michael Macha
b8830332a5 Clarified statement
Previously, the section on ADD_SIGNAL was a little convoluted and not entirely correct. I've fixed mild grammatical issues and expanded on it for new programmers, addressing these issues.
2023-05-04 12:17:26 -06:00
Doonv
bd77af86e6 Fix small typo in the GDExtension C++ example (#7224)
* Fix typo in the GDExtension C++ example

---------

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2023-04-26 18:48:31 +02:00
Rémi Verschelde
27918155b0 GDExtension example: _process delta is a double
It's `Variant::FLOAT` in the bindings, which is always a double.

Changed other member variables for consistency so there's no implicit
conversions between float and double.

Fixes https://github.com/godotengine/godot-cpp/issues/1073.
2023-04-04 15:04:38 +02:00
Patrick
b4f3575d3b Update/Clarify gdextension docs 2023-03-25 01:21:19 +01:00
ganymoe
9df4b09f3f fix paths used in gdextension example
fixes godotengine#7044
2023-03-23 21:30:46 +01:00
Max Hilbrunner
7d5fb4e6a2 Various fixups 2023-03-23 03:13:29 +01:00
Hugo Locurcio
f658307ac7 Add a page on creating custom platform ports 2023-03-13 18:53:38 +01:00
Patrick
11ae34336f Fix GDExtension file path for extension registration
This PR fixes the issue by adding the necessary `/demo` path part.

Fixes https://github.com/godotengine/godot-docs/issues/6872#issuecomment-1452752784
2023-03-03 02:03:48 +01:00
Max Hilbrunner
e4aa65a789 Merge pull request #6840 from konsuko/patch-1
Fix link to Rust GDExtension repository
2023-02-28 11:23:42 +01:00
Konstantin Kopka
c0fb4d2cf2 Fix link to Rust GDExtension repository
The previous link was pointing to the Godot 3.5 Rust GDNative repo.
The new link is pointing to the current/upcoming GDExtension repo.
2023-02-28 14:25:07 +09:00
hakro
445faaac2c Remove duplicate text
2 changes :
- Make the link to godot-cpp more explicit. The phrase `See also Compiling as the build` breaks the flow, and thus the link should be mentioned again
- Remove a duplicate block of text : `If you decide to download the repository ...` which is repeated in the next `Note` block
2023-02-28 01:20:08 +01:00
Patrick
ddd4de4ff0 Fix minor inconsistencies of gdextension docs
* Fixed wrong indentation
* `ADD_SIGNAL` is not a method but a macro which simplifies the usage of the ClassDB method.
2023-02-27 13:11:19 +01: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