godotengine / godotengine/godot-docs

Cheat Sheet for quick reference

Open
#3,182 3 comments 7 reactions 0 assignees View on GitHub
area:manual content:new page enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

A cheat sheet section with common editor usage and scripting needs (also addressing common mistakes), could be useful for new and old users alike.

Right now, basic editor (and engine) usage and scripting is scattered on many documentation pages and could take several trial and errors to make, for example, a simple for range loop.

The cheat sheet that I like how it is formatted is http://haxeflixel.com/documentation/cheat-sheet/
Another one that is good is https://websitesetup.org/php-cheat-sheet/

Some things that this cheat sheet can include:
**Engine:**
- Main Loop: A link to a chart or the page that explains the engine's main loop
- Input events: A link to the chart or page that explains the input event flow

**Editor:**
- Basic 2D scene setup
- Basic 3D scene setup
- Common resource settings (pixel art, 2D, 3D, etc.)
- Asset lib (to promote the usage)
- Common node usage:
- CollisionObjects and CollisionShapes
- Paths and PathFollows
- MeshInstance, MultiMesh and Materials
- The powerful AnimationPlayer
- _more..._

**Scripting:**
- if, for, while
- Input event management
- Working with arrays
- Connecting signals
- Using groups
- get_node usage
- Inspector hints
- setget and its runtime problems with the tree
- Physics:
- Common RigidBody usage and problems
- The same for KinematicBody
- Built in math tools used commonly (including Vector methods)
- Color is float and goes from 0 to 1
- The confusing Tween node
- _and more.._

If there is an interest to make something like this, I suppose that the list of sections and items to include will have to be discussed, particularly with those who are more involved in helping users on the different community channels.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.