Commit Graph

143 Commits

Author SHA1 Message Date
Anton Ivanov
f3586d755a CLion setup: Update path and screenshot for CMakeLists.txt (#4490) 2020-12-27 20:57:15 +01:00
Nathan Lovato
9cd09cc2d0 Merge pull request #4067 from NathanLovato/content/writing-guidelines-updates
Update contribution guidelines
2020-11-23 14:58:53 -06:00
Nathan Lovato
5004e42eb4 Merge pull request #4367 from Calinou/update-core-src-links
Update links to source code files in `core/`
2020-11-15 12:09:53 -06:00
Kowalski
e92a8223d3 Add documentation for debugging Godot Engine with CLion (#4376)
Co-authored-by: Gwendhal CLAUDEL <gwendhal.claudel@epitech.eu>
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-11-15 18:49:50 +01:00
Hugo Locurcio
bf89af481a Update links to source code files in core/
`core/` was reorganized in the `master` branch by
127458ed175c5aeac8dee7f09d23fae4c8928eb7.
2020-11-14 05:40:48 +01:00
Your1405Gaming
f78a25ce3f Fix "intaller" typo in Configuring Visual Studio IDE (#4366) 2020-11-14 03:18:17 +01: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
binotaliu
fe208d1425 Fix "initialize" typo in Code::Blocks configuration page (#4243) 2020-10-10 16:23:48 +02: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
bggd
3b1bf36647 Fix typo "C98" -> "C99" 2020-09-22 16:52:36 +09:00
Yetizone
adc616fed2 qt_creator.rst: Add .glsl to the file extensions step 2020-09-17 14:25:57 +03:00
Yetizone
6ab6e7f609 Qt Creator tutorial: Specify C++ code style settings location (#3979) 2020-09-07 18:14:21 +02:00
parishrutpandey
d356d12421 Fix typo in Custom Godot servers (#3919)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-08-22 00:18:19 +02:00
Hugo Locurcio
515fb6bd6a Link to the Object class reference on the Object class page
People who end up on this page from a search engine might be confused
as to where they can find the Object class reference.
2020-07-10 23:33:20 +02:00
unknown
abb92f1e10 Fix typos in Common engine methods and macros 2020-07-03 22:26:14 +03: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
Rémi Verschelde
206577f9a7 Merge pull request #3698 from madmiraal/add-code_blocks
Add instructions for configuring Code::Blocks as an IDE.
2020-06-22 13:39:27 +02:00
Marcel Admiraal
1f95afa0e1 Add instructions for configuring Code::Blocks as an IDE. 2020-06-22 12:12:34 +01:00
Rémi Verschelde
06b5afcc03 Merge pull request #3701 from Calinou/fix-vformat-example
Fix `vformat()` example in Common engine methods and macros
2020-06-22 10:13:52 +02:00
Andy Maloney
bd4d9f4cd6 Add note about register_types file locations (#3702) 2020-06-19 23:37:15 +02:00
Hugo Locurcio
a135d305ff Fix vformat() example in Common engine methods and macros 2020-06-16 16:53:51 +02:00
Hugo Locurcio
7ee5001213 Add a page about common methods in Godot's C++ codebase
This is geared towards beginner engine contributors, but it could
also be useful to those writing custom C++ modules.
2020-06-08 22:17:34 +02:00
Maganty Rushyendra
08e298c082 Replace register_method with bind_method
ClassDB exposes `bind_method` in order to register functions, and not
`register_method` anymore.
2020-06-08 09:28:44 +08:00
Rémi Verschelde
ce7a9a6eab Images: Remove unused images (no 'image::' or 'figure::' reference) 2020-06-05 14:43:20 +02:00
Rémi Verschelde
39dbbb29e1 Images: always use relative 'img/' paths, without './' prefix
Move some files from root '/img' folder to the location where they are
actually used.
2020-06-05 14:38:25 +02:00
Yuri Sizov
e2e3ecc5b0 Fix typo in VS Code configuration guide (#3628) 2020-06-02 15:11:25 +02:00
Hugo Locurcio
55543f7bac Tweak arguments in the VS Code configuration guide
- Use the long name for the `--editor` option to make it more obvious.
- Document how to run a project directly while debugging.
- Put comments above the line to avoid horizontal overflow.
2020-05-30 22:46:05 +02:00
Dean Brettle
8fb5c787aa Add --path option to sample VS Code launch.json (#3617) 2020-05-30 22:18:53 +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
Yuri Sizov
c0b566cce1 Adjusted language and layout of configuring an IDE docs 2020-05-21 17:34:08 +03: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
e24fee75cb Split IDE instructions into several pages, improve writing style
This removes the link to the KDevelop setup video tutorial as it's
now outdated.

IDE screenshots were also optimized losslessly using
`oxipng -o6 --strip --zopfli`.

See #3485.
2020-05-08 22:03:03 +02:00
Andrii Doroshenko
387882f458 Document GDScript export category and property grouping (#3444)
* Document GDScript export category and property grouping

* Update getting_started/scripting/gdscript/gdscript_exports.rst

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2020-05-04 16:26:18 +02:00
Rémi Verschelde
e6b00ca97a Misc formatting fixes 2020-04-27 12:17:47 +02:00
Rémi Verschelde
e4237e2948 Misc fixes to recent merges 2020-04-27 09:58:08 +02:00
Shlomi
b294afe3e4 Visual Studio Configure Setup and Debugging (#3116)
* Visual Studio Configure Setup and Debugging

My first doc contribution!

* Apply suggestions from Calinou

Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2020-04-26 22:16:01 +02:00
Trams
eb4b3e4d12 Correction in object_class.rst (#3409) 2020-04-19 15:21:52 +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
Rémi Verschelde
11b4a4a91a Fix code errors and style issues after #2750 2020-03-13 16:29:45 +01: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
Hugo Locurcio
63bea370f4 Fix invalid JSON in Custom resource format loaders (#3236)
Comments aren't allowed in JSON, so the note must be put outside
the example.
2020-03-10 10:37:58 +01:00
Yuri Sizov
37604be65f Improved keystroke formatting for shortcuts and key press menti… (#3257) 2020-03-09 23:50:53 +01:00
99alfie
6349d303af replaced erroneous sourcecode parts, added resource saver (#2750)
* replaced erroneous sourcecode parts, added resource saver

* changed spaces to tabs

* changed tabs to 4space+tab(s)

* Update development/cpp/custom_resource_format_loaders.rst

Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-03-02 13:53:07 +01:00