Commit Graph
76 Commits
Author SHA1 Message Date
Max Hilbrunner 273f9a7f2f Merge pull request #10403 from dsnopek/redo-vnen-8751
Add example of GDExtension written pure C
2024-12-15 17:37:40 +01:00
George Marques 874b2792a6 Add example of GDExtension written pure C 2024-12-15 10:06:26 -06:00
tetrapod00 bd25f5813a Simply remove some words 2024-12-14 20:36:17 -08:00
David Snopek 658287759b Improve "Version Compatibility" section in "What is GDExtension" 2024-12-12 17:19:50 -06:00
xix xeaon 609cbcaa94 Add Nim GDExtension 2024-12-04 08:28:11 +01:00
FlooferLand b29d5ecabf Remove link to hxgodot
The url returns a 404, and the project itself was archived in October
2024-11-19 13:03:05 +02:00
Thaddeus Crews f70686cdbe CI: Integrate pre-commit for style checks 2024-11-14 14:08:49 -06:00
tetrapod00 5994348764 Change all usages of "run-time" to "runtime" 2024-11-06 23:36:58 -08:00
Adam Scott 44dfb3a390 Add filenames as captions for code blocks 2024-10-27 16:18:36 -04:00
3ed0339c87 Add a gdextension online documentation guide. (#9966)
* Add a gdextension online documentation guide.

---------

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
Co-authored-by: Patrick Exner (FlameLizard) <patrick.exner1@web.de>
2024-10-08 16:56:39 +02:00
Lukas Tenbrink 252b2fd47e Fix kbd description in gdextension docs system. 2024-09-26 22:27:09 +02:00
Hugo Locurcio 89508cdc98 Fix outdated reference to register_class function in GDExtension C++ example
This was replaced by the `GDREGISTER_CLASS` macro in Godot 4.0.
2024-09-19 01:33:41 +02:00
Hugo Locurcio fe80ff22df Fix ADD_PROPERTY() calls in GDExtension C++ example to use correct syntax
This matches how properties are declared in core Godot.
2024-09-06 22:25:59 +02:00
Hana - Piralein 82292025d9 Update codespell path and fix spelling errors 2024-08-26 07:50:50 +02:00
bruvzg 3414754a36 [GDExtension] Add missing iOS instructions and build/config example code. 2024-08-20 10:59:23 +03:00
Patrick Exner 03f966ab73 Fix project structure diagram in gdextension docs system docs 2024-08-15 19:11:25 +02:00
Balázs Kalydi 91717ff234 Update GDExtension tutorial with the hot reload feature (#9618)
Although the tutorial assumed the hot reload feature, it wasn't enabled in the example config file. Also it didn't mention that it only works if it's compiled in debug mode.
2024-08-14 19:31:17 +02:00
Patrick Exner (FlameLizard)andMax Hilbrunner b21addcf51 Add page about gdextension docs generation (#9667)
* Adding page about gdextension docs generation

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-08-14 19:27:31 +02:00
Patrick Exner 8b37b3c86e Add more precise information about library paths 2024-07-02 22:59:04 +02:00
Patrick Exner 2877a27633 Add dependency section to gdextension file docs 2024-07-01 18:55:41 +02:00
Max Hilbrunner 64164955e8 Merge pull request #9383 from paddy-exe/gdextension-file-quick-reference
Add documentation about .gdextension file
2024-06-23 10:13:53 +02:00
Nathan T.A. LewisandA Thousand Ships 0d58b5ad55 Fix typo
Co-authored-by: A Thousand Ships (she/her) <96648715+AThousandShips@users.noreply.github.com>
2024-06-15 11:11:51 -06:00
Nathan T.A. Lewis 2075def75e Abstract the minor verison number where possible
To ease the maintenance burden in the future, we are abstracting the minor version number to avoid the number of doc updates required.
2024-06-15 09:41:17 -06:00
Nathan T.A. Lewis 42cb5ef1ff Revert compatibility_minimum change
Since 4.2 is still compatible with 4.1, the minimum compatibility can remain 4.1.
2024-06-07 20:07:15 -06:00
Nathan T.A. Lewis 63adb26de9 Update C++ example to use version 4.2 2024-06-07 11:00:03 -06:00
Patrick Exner 7695474656 Add documentation about .gdextension file
Update tutorials/scripting/gdextension/gdextension_file.rst
2024-06-04 12:54:19 +02:00
Patrick Exner 1c49683ee8 Replace ClassDB calls with available macros in GDExtension docs 2024-04-22 11:33:54 +02:00
A Thousand Ships bd6cc665a7 Fix incorrect uses of a/an 2024-03-29 15:14:27 +01:00
Quentin QuaadgrasandRaul Santos 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
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
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