godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity
6,041 Commits 21 Branches 0 Tags
5fce24792dc5f99e0066019dbc035331e680e77c
Commit Graph

50 Commits

Author SHA1 Message Date
Nora
c1b7505ef8 Update Custom Modules Latest to include header and class name changes. (#5205) 2022-04-29 14:31:35 +02:00
Hugo Locurcio
242b39749f Mention GDNative versus shared libraries in Custom modules in C++ 2022-04-06 19:21:20 +02:00
Rémi Verschelde
9a05eef561 4.0: Convert Sprite references to Sprite2D 
Some screenshots will need to be updated so that the scene structures shown
in screenshot fit what the code blocks are referring to.
 2021-10-06 14:29:55 +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
Max Hilbrunner
97fccb37de Merge pull request #4958 from LightningAA/improve-modules-tutorial 
Minor improvements to `Custom modules in C++` tutorial
 2021-07-06 14:06:43 +02:00
Adam Trhoň
1c63513036 Remove obsolete C++11 flag from C++ module examples (#5057) 
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
 2021-06-29 19:00:03 +02:00
Aaron R
41ccfc09bf Minor improvements to Custom modules in C++ 2021-06-05 10:57:01 -10:00
Hugo Locurcio
8c4bd39379 Remove obsolete CXXFLAGS override in Custom modules in C++ 
This line is actually harmful now that Godot defaults to C++17.
 2021-05-17 14:47:50 +02:00
Nathan Lovato
d475940178 Update references to the docs guidelines 
We split some pages into two and some remaining references were leading to an
irrelevant page.
 2020-11-13 11:05:40 -06:00
Hugo Locurcio
70e5410347 Document caveats related to multiple inheritance in C++ modules 2020-09-28 17:56:12 +02:00
Andrii Doroshenko
8c5a168966 Document unit testing in the engine and modules (#4017) 2020-09-27 15:06:37 +02:00
Andy Maloney
c52533fc46 Clarify setting of library environment variables in module examples (#3730) 
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
 2020-06-26 19:46:04 +02:00
Andy Maloney
bd4d9f4cd6 Add note about register_types file locations (#3702) 2020-06-19 23:37:15 +02:00
Hugo Locurcio
43410b3c86 Tweak LD_LIBRARY_PATH export to work with paths that contain spaces (#3585) 
This also uses the `$PWD` environment variable which should always
be defined. It's also minutely faster than calling `$(pwd)` or using
the deprecated backtick syntax.
 2020-05-26 14:24:56 +02:00
Andrii Doroshenko
9539091084 Document custom_modules build option (#3595) 
* Document `custom_modules` build option
 2020-05-26 14:23:15 +02:00
Hugo Locurcio
47b0721d8a Capitalize all instances of Git in the documentation 2020-05-23 18:34:55 +02:00
Max Hilbrunner
7371968b82 Merge pull request #3006 from Relintai/module-doc-fix 
Improve the 'Writing custom documentation' section
 2020-05-20 11:30:31 +02:00
Hugo Locurcio
ec77f48d5e Add documentation about exporting for dedicated servers 
This also documents how to build dedicated server binaries.
The part about compiling will need to be updated for Godot 4.0
once the server platform is usable again.

This also removes prompts before commands so that they can be
copy-pasted by triple-clicking without selecting the prompt.
 2020-05-19 21:52:23 +02:00
Relintai
01bec86e2d Improve the 'Writing custom documentation' section. 2020-05-19 19:07:53 +02:00
Hugo Locurcio
046215542d Fix some typos and grammar mistakes found using LanguageTool 2020-04-16 23:07:05 +02:00
Yuri Sizov
4acf7a6563 Fix syntax highlighting for various languages (#3387) 2020-04-15 16:33:20 +02:00
Hugo Locurcio
6fb8d9b5de Rename all instances of the x11 platform to linuxbsd 
Export template binaries haven't been renamed yet, so their names
were left as-is.
 2020-04-01 09:15:45 +02:00
Andrii Doroshenko
5b39f781ae Document modules ability to pre-register types (#3250) 
`preregister_*_types()` is available to modules since
Vulkan branch has been merged.
 2020-03-10 11:12:56 +01:00
Rémi Verschelde
1df5a0ae68 Merge pull request #3061 from asynts/asynts.syntax-highlighting-2 
Incorrect syntax highlighting for languages other than GDScript.
 2020-01-27 08:39:00 +01:00
Hugo Locurcio
4b1502e4e1 Mention export template caveats when creating a C++ module 
See https://github.com/godotengine/godot/issues/35299.
 2020-01-20 17:45:43 +01:00
asynts
53f878bdaf Replace 'code' directives with 'code-block' directives. 
The `code` directive highlights all sources as GDScript. Other languages are
highlighted incorrectly at the moment, even if `.. code:: [language]` is
specified.

It does, however, work with the `code-block` directive. The reason seems to be
that this directive is Sphinx specific.
 2020-01-13 18:45:39 +01:00
frido
2f4b025b14 Fix some typos in 'development' and 'getting started' sections 2019-10-10 23:51:29 +02:00
skyace65
f2fe133e01 Add note about parameter limit in C++ modules 2019-09-28 12:05:48 -04:00
Andrii Doroshenko (Xrayez)
209af20763 Describe the process of creating editor icons globally and per module 
Also created a new `Editor development` chapter/section to encompass
C++ editor development side specifically which is not necessarily
related to pure core development, generic types and patterns.
 2019-09-01 23:41:48 +03:00
Remi Rampin
91897778b2 [Minor] Fix "it's" that should be "its" (#2595) 
* Fix "it's" that should be "its"

* Other fixes
 2019-07-15 17:44:07 +09:00
Rémi Verschelde
4beac25f03 Proofread SCons examples 2019-07-03 09:46:30 +02:00
follower
3282d8f429 Minor typo/grammar fix: "you" -> "your" 
Although I suspect this could be better written as something like:

> **Note**: You have to ``export`` the environment variable otherwise
> you won't be able to play your project from within the editor.
 2019-04-14 17:49:46 +12:00
Nathan Banks
053418ef6f Update custom_modules_in_cpp.rst 
Fixed a typo.

(cherry picked from commit 955666e8b4)
 2019-03-01 23:53:25 +01:00
Rémi Verschelde
3a6fa1507c Merge pull request #1892 from Calinou/capitalize-godot 
Capitalize all instances of Godot (except the binary name)
 2018-11-20 09:55:17 +01:00
Michael Alexsander Silva Dias
2d019998b5 Fix small problems in the "External libraries" and "Custom modules" pages 2018-11-15 14:06:32 -02:00
m
affa0f3542 Added example for binding to external C++ libary #513 
Updated the custom C++ modules documentation with an example of binding to an external C++ library, using the Festival text-to-speech library.
 2018-11-10 19:15:12 -05:00
Hugo Locurcio
adf3cb915a Capitalize all instances of Godot (except the binary name) 2018-10-27 21:01:11 +02:00
Rémi Verschelde
81e1d6da60 Fix core includes in C++ modules tutorial 
Fixes #1787.
 2018-10-03 15:34:00 +02:00
Ralph Minderhoud
2ff103e117 Update config example function signature 
The previous example caused godot to display the following warning:

`Warning: module 'module' uses a deprecated 'can_build' signature in its config.py file, it should be 'can_build(env, platform)'.`
 2018-06-30 16:43:39 -05:00
mhilbrunner
3fa4cc3355 Reinstate fun 2018-05-08 08:36:51 +02:00
mhilbrunner
f215a0cf26 Proofing/review: Remove filler words, adhere to style guide 2018-05-06 05:23:37 +02:00
Simon
33ba2003de Fixed build command for libsummator 2018-02-07 08:56:48 -08:00
Max Hilbrunner
cabf76f74d Custom modules in CPP: Remove mention of Bullet 
Remove Bullet from list of external third-party libraries that may be interesting to write bindings for now that it's integrated, also correct PhysX spelling
 2018-02-01 02:51:55 +01:00
Emerson MX
1dece629ed Rename OBJ_TYPE to GDCLASS 2018-01-25 00:17:25 -03:00
Andrii Doroshenko (Xrayez)
0ff5c10e88 Add section about writing custom documentation for modules 2018-01-21 19:44:06 +02:00
Maksymilian Świąć
8496ceb472 Update two outdated statements in the modules and plugins docs (#521) 
* Remove the 2.1 warning wrt plugins

* More than 2 modules exist now
 2017-10-15 20:16:34 +02:00
Tyler Yocolano
e0769435ba The function in ClassDB is register_class not register_types 
The function in ClassDB is register_class not register_types
 2017-07-18 07:58:42 +02:00
Poommetee Ketson
08ba9d2212 CustomModule: update example to use ClassDB 2017-05-22 04:52:38 +07:00
ssj71
447b439db5 examples for custom module SCsub 
I needed to add multiple files and include paths and it took me a bit
of digging to figure out how to do it. Hopefully this will help the next guy.
 2017-04-04 07:53:07 +02:00
Julian Murgia
b408bdb918 Revamping of the docs organisation for a more coherent TOC 
Only the pages were moved so far and some empty ones created,
the up-to-date toctrees come in the next commit.
 2017-04-03 23:23:31 +02:00