stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
3,756 Commits 21 Branches 0 Tags
5f99fcb9fb33b8c596eda0a5ca8a5a9520d66e1f
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Hugo Locurcio 5f99fcb9fb Add a Tween cheatsheet image 
Taken from https://github.com/wandomPewlin/godotTweeningCheatSheet
with the author's permission.

The image isn't referenced in this repository, but will be referenced
in the Tween class reference.
 2020-04-17 23:05:51 +02:00
Hugo Locurcio d2a420b3a8 Document how to update the inspector after setting an exported variable 
This closes https://github.com/godotengine/godot/issues/21009.
 2020-04-17 12:06:38 +02:00
Hugo Locurcio 046215542d Fix some typos and grammar mistakes found using LanguageTool 2020-04-16 23:07:05 +02:00
Hugo Locurcio 8e0caddac3 Fix typos found using codespell -wi3 ^classes/**/*.rst 2020-04-16 21:01:09 +02:00
Hugo Locurcio ac4c28d279 Add advice about local variables in the GDScript and C# style guides 2020-04-15 11:45:23 +02:00
Hugo Locurcio d4eb2cc1da Add issue templates 
This should make the issue reporting flow a bit smoother.
 2020-04-14 09:46:54 +02:00
Hugo Locurcio 293ccf7f68 Add a style guide for the Godot shader language 
This closes #3091.
 2020-04-11 21:01:28 +02:00
Hugo Locurcio c50cd002ad Make the documentation logo hiDPI-friendly 
This also sets the documentation logo to a fixed size in the CSS
to prevent reflows during page loading.
 2020-04-11 13:38:25 +02:00
Hugo Locurcio 9355c0f152 Set up continuous integration using Travis CI 
This is used to catch build warnings early on.
 2020-04-10 10:02:57 +02:00
Hugo Locurcio 087835e400 Add section on platform not appearing in SCons in Compiling for Android 
This closes #3361.
 2020-04-10 09:49:54 +02:00
Hugo Locurcio 62725b30f1 Move the GDScript history to the FAQ, reference it in GDScript basics 2020-04-09 16:24:31 +02:00
Hugo Locurcio 76bf1d2636 Add singular "Signal" meta keyword to signal tutorials 
This makes possible to find them when searching for "signal",
instead of just "signals".

This closes #2629.
 2020-04-09 15:00:51 +02:00
Hugo Locurcio 32d9019e5e Always use parentheses when calling assert() in GDScript 
This is now required since Godot 3.2.

This also adds an assert message to the Godot interfaces page to match
its C# counterpart.
 2020-04-09 14:46:36 +02:00
Hugo Locurcio fdc96af659 Fix Scenes and Nodes tree image being unreadable on dark theme 
This closes #3351.
 2020-04-08 15:46:13 +02:00
Hugo Locurcio 6929a811bc Fix the dead links for the thumbstick dead zones pages 
The host is no longer online, so we'll point to the archived version
instead.

This also removes a redundant note in the VR starter tutorial.

This closes #3343.
 2020-04-04 23:19:08 +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
Hugo Locurcio 52884b8621 Add a page about finding regressions using git bisect 
This is a common process during Godot development. Making it
more accessible to newcomers should help bugs be resolved faster.
 2020-03-14 14:10:51 +01:00
Hugo Locurcio 00d1d906d4 Clarify CSV encoding requirements when importing translations (#3211) 
Since Excel has no easy way to save files to UTF-8, this adds
a warning that recommends using LibreOffice or Google Sheets instead.

This closes https://github.com/godotengine/godot-docs/issues/2453.
 2020-03-13 12:31:40 +01:00
Hugo Locurcio 6a5632eabc Improve the Docs writing guidelines page 
This also integrates keyboard shortcut recommendations as outlined
in #3257.
 2020-03-10 19:32:34 +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
Hugo Locurcio 3f360ce5dd Add information on compiling Godot on Linux using Clang + LLD (#3210) 
This also mentions link-time optimization as in the
Compiling for Windows page.
 2020-03-10 10:35:32 +01:00
Hugo Locurcio c4da962f3c Improve the Light transport in game engines documentation (#2742) 
This also fixes a Sphinx build warning caused by `_scene referred_`.
Using `*` for italics solves the issue.
 2020-03-08 23:42:44 +01:00
Hugo Locurcio d63e0e32d9 Revert "Add scrollbar to the navigation bar (#3237)" 
Unfortunately, this breaks the fixed search bar, which harms
usability quite a bit. It also looked bad on mobile.

This reverts commit ac6dc251f7.
 2020-03-05 21:33:41 +01:00
Hugo Locurcio ff2b3e4d00 Add documentation for version 1 of the Godot Android plugin. (#2979) 
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
 2020-03-05 18:13:34 +01:00
Hugo Locurcio 4dccd9fbd4 Describe how to load a C# DLC (#3242) 
Explains how to load a PCK made from a C# project.

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
 2020-03-04 23:58:55 +01:00
Hugo Locurcio 32460e7e31 Fix a typo in an Exporting for Web code sample (#3241) 2020-03-04 22:24:51 +01:00
Hugo Locurcio 6b3ed0474c Mention RAM requirements for building using Sphinx 
This closes #3239.
 2020-03-04 09:50:06 +01:00
Hugo Locurcio c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 
This reverts commit 309a4382c9.

Per #3239, it turns out parallel builds use too much RAM for the
average PC out there.

This closes #3239.
 2020-03-04 09:41:32 +01:00
Hugo Locurcio 3fcbe00654 Update the C# EmitSignal() code sample in the signals tutorial 
The GDScript code sample was updated in
f044f2607e. This updates the C#
code sample.
 2020-03-03 22:54:23 +01:00
Hugo Locurcio 15e34cb0de Improve the Compiling for macOS documentation 
- Mention Homebrew to install dependencies easily.
- Remove the part about building fat binaries as support for 32-bit
  macOS was removed in Godot 3.1.
- Improve OSXCross installation instructions.
  - Mention the WSL as an alternative on Windows instead of Cygwin.
  - Change the suggested OSXCross path to something that will work
    out of the box.
 2020-03-03 10:47:51 +01:00
Hugo Locurcio 9902e4fe32 Format gdscript.py and conf.py using Black and Flake8 
This also adds a missing comma in the middle of the list of
built-in types. The `name`, `funcname` and `classname` were also
missing a `r` qualifier, so it was added.

Commands used for formatting and linting:

    black conf.py extensions/gdscript.py
    flake8 --ignore E501 conf.py extensions/gdscript.py
 2020-03-02 14:57:01 +01:00
Hugo Locurcio b061ebf005 Add a page on installing plugins 
This closes #2491.
 2020-02-29 22:41:55 +01:00
Hugo Locurcio c65224c864 Use correct indentation in the XML example in the class reference guide 2020-02-16 22:59:23 +01:00
Hugo Locurcio 200d451b7a Fix highlighting of XML tags when using a dark theme 2020-02-16 22:55:48 +01:00
Hugo Locurcio 48579bcfdf Prevent the 3.2 branch from being indexed by search engines 
See #3002 for rationale.
 2020-02-03 23:23:20 +01:00
Hugo Locurcio b062a204d3 Add dark theme colors for Danger admonitions 
This closes #3135.
 2020-02-02 01:27:11 +01:00
Hugo Locurcio 122227c6aa Improve image compression recommendations in Importing images 2020-01-31 20:51:44 +01:00
Hugo Locurcio f675bc262c Add documentation on supported image types 
This closes #3132.
 2020-01-31 19:50:29 +01:00
Hugo Locurcio c1c5cd62cd Fix some images being difficult to read when using the dark theme 
Adding the background color `#fcfcfc` (which matches the light theme's
background color) makes images readable again when using the dark theme.
 2020-01-31 01:54:15 +01:00
Hugo Locurcio 4922ee43a8 Fix the display of very long class names in the navigation bar 
This closes #3092.
 2020-01-29 01:51:52 +01:00
Hugo Locurcio 36b76ba70a Fix search bar shadow when it's not fixed due to scrolling yet 
This closes #3113.
 2020-01-29 01:47:02 +01:00
Hugo Locurcio bfb43a706a Improve the fixed search bar 
The search bar will now behave in a "sticky" manner. This makes
the logo disappear more smoothly instead of being abruptly hidden.
Another upside is that the drop shadow will only appear once the
search bar is made fixed.
 2020-01-23 19:44:57 +01:00
Hugo Locurcio a3ab30906b Make the search bar fixed, hide the logo when scrolling down 
This closes #2778.
 2020-01-23 16:58:56 +01:00
Hugo Locurcio c0e1cfc52c Fix the "Caution" admonition colors when using the dark theme 2020-01-21 19:07:13 +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
Hugo Locurcio 8a39883ed6 Fix the Read the Docs version selector not being centered 
This closes #3081.
 2020-01-20 17:40:45 +01:00
Hugo Locurcio a504ab1647 Mention the Godot data paths specific to the Flatpak version 2020-01-19 18:18:57 +01:00
Hugo Locurcio ffb1f55f96 Center the page on wide displays 
This prevents the main content from being stuck at the left of
the page, which in turn makes it more comfortable to read.
 2020-01-18 19:54:45 +01:00
Hugo Locurcio b8c0f6e19d Update some exporting images and move a line (#3060) 
Update some exporting images and move a line
 2020-01-13 21:47:55 +01:00
Hugo Locurcio 24aa74eb89 Merge pull request #3058 from igorashs/patch-1 
Fix typo in Vector2 description
 2020-01-13 11:58:30 +01:00
Hugo Locurcio 9e8fb108cc Add a dark theme using the prefers-color-scheme CSS media query 
This also includes tweaks to the syntax highlighting theme
which were necessary to support switching the theme using CSS
variables. Some token colors in the light syntax theme have been
swapped around for consistency.

This closes #3041.
 2020-01-12 03:45:05 +01:00
Hugo Locurcio b0724a214d Merge pull request #3046 from aaronfranke/main-screen-sizeflag 
Mention size flag in main screen plugin tutorial
 2020-01-09 21:34:35 +01:00
Hugo Locurcio 1f1a934eec Merge pull request #3042 from skyace65/scene_tree 
Updates scene tree image for Godot 3.2
 2020-01-06 12:09:25 +01:00
Hugo Locurcio cba5770d19 Merge pull request #3036 from flofriday/fix-orientation-handheld 
Fix Orientation on Android
 2020-01-04 00:00:13 +01:00
Hugo Locurcio 529004eec2 Merge pull request #3005 from van800/master 
"Profiling your C# code" in c_sharp_basics.rst
 2020-01-03 22:42:23 +01:00
Hugo Locurcio 3a6a1586c9 Merge pull request #3011 from DesiQuintans/patch-1 
Clarify touch-input-from-mouse
 2020-01-03 21:46:24 +01:00
Hugo Locurcio efd4cb31c7 Merge pull request #3034 from YeldhamDev/builtin_type_refs 
Add references for the built-in type pages in GDScript basics
 2020-01-03 21:45:23 +01:00
Hugo Locurcio dd1e849d86 Merge pull request #3033 from skyace65/multimeshCSharp 
Add C# code to multimesh page
 2020-01-03 18:42:50 +01:00
Hugo Locurcio 198ddc7dc8 Merge pull request #3028 from vintprox/patch-2 
Changled link to Shadertoy (mirror #3026)
 2020-01-03 00:20:33 +01:00
Hugo Locurcio a978a750de Remove outdated info from intro to animation editor page (#3029) 
Remove outdated info from intro to animation editor page
 2020-01-03 00:03:02 +01:00
Hugo Locurcio 924ce1bd66 Merge pull request #3027 from skyace65/singletons 
Update Singletons Autoload image for Godot 3.2
 2020-01-02 19:15:11 +01:00
Hugo Locurcio 2d265dbf66 Merge pull request #3026 from vintprox/patch-1 
Changed link to GPU intensive website.
 2020-01-02 19:09:46 +01:00
Hugo Locurcio 32283361a8 Merge pull request #3023 from N0hbdy/making-plugins-warning 
Add warning to making-plugins reminding about tool keyword
 2020-01-02 15:48:08 +01:00
Hugo Locurcio 58c3a2706c Merge pull request #3020 from madmiraal/windows-yasm 
Add yasm to scoop install.
 2019-12-31 18:20:58 +01:00
Hugo Locurcio 408a502f4b Add a FAQ meta keyword to the frequently asked questions page 
This makes it possible to find that page by simply searching "faq"
in the documentation search. Previously, no results would have been
returned.
 2019-12-30 16:14:53 +01:00
Hugo Locurcio f555d867e2 Use sound pressure level rather than power (#3010) 
Use sound pressure level rather than power
 2019-12-28 00:20:58 +01:00
Hugo Locurcio 95d3f4261c Merge pull request #3009 from Enhex/patch-1 
fixed variable name
 2019-12-27 20:45:40 +01:00
Hugo Locurcio 0e25a6120d Merge pull request #3008 from YeldhamDev/gdscript_exports_small_fixup 
Very small styling fixups to the GDScript export page
 2019-12-27 20:38:37 +01:00
Hugo Locurcio 5579022cd7 Add link to tool docs in gdscript docs. (#3003) 
Add link to tool docs in gdscript docs.
 2019-12-24 16:55:49 +01:00
Hugo Locurcio f3aaa480e2 Add an enum naming guideline to the GDScript style guide 
This partially addresses #1736.
 2019-12-20 19:31:16 +01:00
Hugo Locurcio c6fa2483f8 Add a boolean operators guideline to the GDScript style guide 2019-12-20 19:17:11 +01:00
Hugo Locurcio bc47ace471 Add a line length guideline to the GDScript style guide 
This closes #2567.
 2019-12-20 19:06:56 +01:00
Hugo Locurcio 9d889f81f6 Merge pull request #2957 from merumelu/gdnative-folded-over-1000-times 
Remove `_sections_unfolded` noise in GDNative C++ example
 2019-11-30 19:48:39 +01:00
Hugo Locurcio 42b6d29556 Merge pull request #2950 from Jayman2000/promotion-fix 
Made "promotion" into an adjective
 2019-11-29 01:08:08 +01:00
Hugo Locurcio 7a9635d58b Clarify how .gdignore works in Project organization 2019-11-26 23:30:57 +01:00
Hugo Locurcio 218794d55d Mention that ETC texture compression doesn't support transparency 
This closes #2899.
 2019-11-25 14:42:18 +01:00
Hugo Locurcio 77ccd38fea Plugin Tutorial _ExitTree c# example comment fix (#2932) 
Plugin Tutorial _ExitTree c# example comment fix
 2019-11-24 23:55:26 +01:00
Hugo Locurcio 179157584e Merge pull request #2945 from Martin1991zab/patch-1 
fix 2 dead links in README.md
 2019-11-24 23:52:38 +01:00
Hugo LocurcioandNicholas Hydock 6b683b77ca Tweak the theme to better match Godot's visual identity 
This also removes the need to load Web fonts, leading to a smoother
page loading experience.

Co-authored-by: Nicholas Hydock <nhydock@users.noreply.github.com>
 2019-11-19 22:05:23 +01:00
Hugo Locurcio 80bd273bdd Improve grammar and writing in Design a title screen 2019-11-18 13:49:57 +01:00
Hugo Locurcio 193b866848 Add quote style recommendation to the GDScript style guide 
This closes #2869.
 2019-11-14 15:00:28 +01:00
Hugo Locurcio 3b80f17e8d Add Alpine Linux dependencies oneliner in Compiling for X11 2019-11-10 20:32:15 +01:00
Hugo Locurcio 6f16e321d7 Merge pull request #2906 from ankeris/http_req_example_fix 
Fixed http request example that was not working
 2019-11-02 16:16:07 +01:00
Hugo Locurcio 304157775d Mention the SCons version requirement when using Visual Studio 2019 2019-10-29 14:31:12 +01:00
Hugo Locurcio 7b66eb5205 minor grammar changes (#2885) 
minor grammar changes
 2019-10-27 00:04:05 +02:00
Hugo LocurcioandnikhilCad fa77e6c0fc Add a note about ConfigFile in the Saving games tutorial 
This closes #2879.

Co-authored-by: nikhilCad <47214394+nikhilCad@users.noreply.github.com>
 2019-10-26 18:05:48 +02:00
Hugo Locurcio b629a28d24 Merge pull request #2882 from yeonghoey/revert-2842 
Revert "Mention additional MinGW compilation troubleshooting tips"
 2019-10-26 00:09:55 +02:00
Hugo Locurcio 7270c76c5d Improve the Custom builds for Android page 
This closes #2870.
 2019-10-21 21:55:32 +02:00
Hugo Locurcio 4b960279df Add missing alsa-lib-devel package in Solus installation oneliner 
This also removes `pulseaudio` from the oneliner, as it's already
installed by `pulseaudio-devel`.

See #2865.
 2019-10-21 18:53:31 +02:00
Hugo Locurcio c169b8adbb Fix res:// appearing as an URL in Scenes and nodes (#2741) 
Fix `res://` appearing as an URL in Scenes and nodes
 2019-10-20 14:21:12 +02:00
Hugo Locurcio 2989dd0381 Merge pull request #2863 from e8johan/e8johan-yield-animation_finished 
Change example signal name to animation_finished
 2019-10-19 17:31:54 +02:00
Hugo Locurcio bd8b0b66f2 Merge pull request #2851 from remram44/gettext-pybabel 
Gettext pybabel
 2019-10-13 23:07:30 +02:00
Hugo Locurcio 25c94ccb82 Clarify how the "step" value behaves in GDScript exports 2019-10-11 10:27:26 +02:00
Hugo Locurcio d7cf5991ac Mention additional MinGW compilation troubleshooting tips 
See https://github.com/godotengine/godot/issues/32695.
 2019-10-10 16:09:54 +02:00
Hugo Locurcio 4787c234ef Fix various typos and grammar issues in tutorial articles (#2839) 
Fix various typos and grammar issues in tutorial articles
 2019-10-10 00:45:05 +02:00
Hugo Locurcio fdac2a6db5 Improve the Handling quit requests page 2019-10-08 19:14:22 +02:00
Hugo Locurcio 5a0c3c6b70 Merge pull request #2832 from chesscommands/patch-3 
Correct spelling mistakes
 2019-10-07 15:33:50 +02:00
Hugo Locurcio 2f9ffbb551 Fix a function name in GDNative C tutorial (#2828) 
Fix a function name in GDNative C tutorial
 2019-10-06 15:45:54 +02:00
Hugo Locurcio 045650af90 Update documentation guidelines for new simplified GitHub procedure 
The edit URL is now customizable on Read the Docs, which means
it's no longer necessary to edit the URL manually.
 2019-10-05 18:26:05 +02:00
Hugo Locurcio b69317bb53 Merge pull request #2807 from taner1es/patch-1 
Fix: FPS TUT. PART 5 - Problematic Null Control
 2019-10-04 18:14:50 +02:00