Merge pull request #496 from aaronfranke/demo-categories

Categorize demos and add README files
godotengine · Jul 4, 2020 · 2434876 · 2434876
2 parents c33ce26 + 8dff86d
commit 2434876
Show file tree

Hide file tree

Showing 82 changed files with 114 additions and 24 deletions.
diff --git a/2d/README.md b/2d/README.md
@@ -0,0 +1,8 @@
+# 2D Demos
+
+These demos are all 2D, but otherwise do not have a common theme.
+
+Languages: Most have GDScript, some have
+[GDSL](https://docs.godotengine.org/en/latest/tutorials/shading/shading_reference/shading_language.html)
+
+Renderers: 6 of them are GLES 3, but most are GLES 2
diff --git a/misc/instancing/README.md → 2d/instancing/README.md b/misc/instancing/README.md → 2d/instancing/README.md
diff --git a/misc/instancing/ball.tscn → 2d/instancing/ball.tscn b/misc/instancing/ball.tscn → 2d/instancing/ball.tscn
diff --git a/misc/instancing/ball_factory.gd → 2d/instancing/ball_factory.gd b/misc/instancing/ball_factory.gd → 2d/instancing/ball_factory.gd
diff --git a/misc/instancing/bowling_ball.png → 2d/instancing/bowling_ball.png b/misc/instancing/bowling_ball.png → 2d/instancing/bowling_ball.png
diff --git a/misc/instancing/bowling_ball.png.import → 2d/instancing/bowling_ball.png.import b/misc/instancing/bowling_ball.png.import → 2d/instancing/bowling_ball.png.import
diff --git a/misc/instancing/icon.png → 2d/instancing/icon.png b/misc/instancing/icon.png → 2d/instancing/icon.png
diff --git a/2d/sdf_font/icon.png.import → 2d/instancing/icon.png.import b/2d/sdf_font/icon.png.import → 2d/instancing/icon.png.import
diff --git a/misc/instancing/project.godot → 2d/instancing/project.godot b/misc/instancing/project.godot → 2d/instancing/project.godot
diff --git a/misc/instancing/scene_instancing.tscn → 2d/instancing/scene_instancing.tscn b/misc/instancing/scene_instancing.tscn → 2d/instancing/scene_instancing.tscn
diff --git a/2d/sdf_font/screenshots/.gdignore → 2d/instancing/screenshots/.gdignore b/2d/sdf_font/screenshots/.gdignore → 2d/instancing/screenshots/.gdignore
diff --git a/misc/instancing/screenshots/instancing.png → 2d/instancing/screenshots/instancing.png b/misc/instancing/screenshots/instancing.png → 2d/instancing/screenshots/instancing.png
diff --git a/2d/screen_space_shaders/README.md b/2d/screen_space_shaders/README.md
@@ -5,7 +5,7 @@ Many common full-res effects are implemented here for reference.
 
 Language: [GDSL](https://docs.godotengine.org/en/latest/tutorials/shading/shading_reference/shading_language.html) and GDScript
 
-Renderer: GLES 3
+Renderer: GLES 3 (the blur effect is not available in GLES 2, the rest work)
 
 ## Screenshots
 

diff --git a/2d/sdf_font/default_environment.tres b/2d/sdf_font/default_environment.tres
diff --git a/misc/tween/README.md → 2d/tween/README.md b/misc/tween/README.md → 2d/tween/README.md
diff --git a/misc/tween/godot.png → 2d/tween/godot.png b/misc/tween/godot.png → 2d/tween/godot.png
diff --git a/misc/tween/godot.png.import → 2d/tween/godot.png.import b/misc/tween/godot.png.import → 2d/tween/godot.png.import
diff --git a/misc/tween/icon.png → 2d/tween/icon.png b/misc/tween/icon.png → 2d/tween/icon.png
diff --git a/misc/android_iap/icon.png.import → 2d/tween/icon.png.import b/misc/android_iap/icon.png.import → 2d/tween/icon.png.import
diff --git a/misc/tween/main.gd → 2d/tween/main.gd b/misc/tween/main.gd → 2d/tween/main.gd
diff --git a/misc/tween/main.tscn → 2d/tween/main.tscn b/misc/tween/main.tscn → 2d/tween/main.tscn
diff --git a/misc/tween/project.godot → 2d/tween/project.godot b/misc/tween/project.godot → 2d/tween/project.godot
diff --git a/misc/instancing/screenshots/.gdignore → 2d/tween/screenshots/.gdignore b/misc/instancing/screenshots/.gdignore → 2d/tween/screenshots/.gdignore
diff --git a/misc/tween/screenshots/tween.png → 2d/tween/screenshots/tween.png b/misc/tween/screenshots/tween.png → 2d/tween/screenshots/tween.png
diff --git a/3d/README.md b/3d/README.md
@@ -0,0 +1,7 @@
+# 3D Demos
+
+These demos are all 3D, but otherwise do not have a common theme.
+
+Languages: All are GDScript
+
+Renderers: Truck Town and Physics Tests are GLES 2, the rest are GLES 3
diff --git a/audio/README.md b/audio/README.md
@@ -0,0 +1,7 @@
+# Audio Demos
+
+These demos showcase various audio features.
+
+Languages: All are GDScript
+
+Renderers: All are GLES 2
diff --git a/gui/README.md b/gui/README.md
@@ -0,0 +1,8 @@
+# GUI Demos
+
+These demos showcase GUI features and text features via
+[`Control`](https://docs.godotengine.org/en/latest/classes/class_control.html) nodes.
+
+Languages: All are GDScript, except SDF has no code
+
+Renderers: All are GLES 2
diff --git a/gui/drag_and_drop/drag_drop_script.gd b/gui/drag_and_drop/drag_drop_script.gd
@@ -1,12 +1,12 @@
 extends ColorPickerButton
 
 func get_drag_data(_pos):
-	# Use another colorpicker as drag preview
+	# Use another colorpicker as drag preview.
 	var cpb = ColorPickerButton.new()
 	cpb.color = color
 	cpb.rect_size = Vector2(50, 50)
 	set_drag_preview(cpb)
-	# Return color as drag data
+	# Return color as drag data.
 	return color
 
 

diff --git a/misc/regex/README.md → gui/regex/README.md b/misc/regex/README.md → gui/regex/README.md
diff --git a/misc/regex/icon.png → gui/regex/icon.png b/misc/regex/icon.png → gui/regex/icon.png
diff --git a/misc/instancing/icon.png.import → gui/regex/icon.png.import b/misc/instancing/icon.png.import → gui/regex/icon.png.import
diff --git a/misc/regex/project.godot → gui/regex/project.godot b/misc/regex/project.godot → gui/regex/project.godot
diff --git a/misc/regex/regex.gd → gui/regex/regex.gd b/misc/regex/regex.gd → gui/regex/regex.gd
diff --git a/misc/regex/regex.tscn → gui/regex/regex.tscn b/misc/regex/regex.tscn → gui/regex/regex.tscn
diff --git a/misc/multitouch_view/screenshots/.gdignore → gui/regex/screenshots/.gdignore b/misc/multitouch_view/screenshots/.gdignore → gui/regex/screenshots/.gdignore
diff --git a/misc/regex/screenshots/regex.png → gui/regex/screenshots/regex.png b/misc/regex/screenshots/regex.png → gui/regex/screenshots/regex.png
diff --git a/gui/rich_text_bbcode/rich_text_bbcode.gd b/gui/rich_text_bbcode/rich_text_bbcode.gd
@@ -2,7 +2,7 @@ extends Panel
 
 func _on_RichTextLabel_meta_clicked(meta):
 	var err = OS.shell_open(meta)
-	if (err == OK):
+	if err == OK:
 		print("Opened link '%s' successfully!" % meta)
 	else:
 		print("Failed opening the link '%s'!" % meta)
diff --git a/2d/sdf_font/README.md → gui/sdf_font/README.md b/2d/sdf_font/README.md → gui/sdf_font/README.md
@@ -4,7 +4,7 @@ This is a demo of Signed Distance Field fonts in Godot.
 The technique used allows the text to remain clear
 under arbitrary zooms and rotations.
 
-Language: GDScript
+Language: This demo contains no code.
 
 Renderer: GLES 3 (this effect is not available in GLES 2)
 

diff --git a/2d/sdf_font/font.font → gui/sdf_font/font.font b/2d/sdf_font/font.font → gui/sdf_font/font.font
diff --git a/2d/sdf_font/icon.png → gui/sdf_font/icon.png b/2d/sdf_font/icon.png → gui/sdf_font/icon.png
diff --git a/misc/multitouch_cubes/icon.png.import → gui/sdf_font/icon.png.import b/misc/multitouch_cubes/icon.png.import → gui/sdf_font/icon.png.import
diff --git a/2d/sdf_font/project.godot → gui/sdf_font/project.godot b/2d/sdf_font/project.godot → gui/sdf_font/project.godot
@@ -34,4 +34,3 @@ singletons=[  ]
 [rendering]
 
 environment/default_clear_color=Color( 0.18, 0.1188, 0.15348, 1 )
-environment/default_environment="res://default_environment.tres"
diff --git a/misc/regex/screenshots/.gdignore → gui/sdf_font/screenshots/.gdignore b/misc/regex/screenshots/.gdignore → gui/sdf_font/screenshots/.gdignore
diff --git a/2d/sdf_font/screenshots/sdf.png → gui/sdf_font/screenshots/sdf.png b/2d/sdf_font/screenshots/sdf.png → gui/sdf_font/screenshots/sdf.png
diff --git a/2d/sdf_font/sdf_font_demo.tscn → gui/sdf_font/sdf_font_demo.tscn b/2d/sdf_font/sdf_font_demo.tscn → gui/sdf_font/sdf_font_demo.tscn
@@ -6,7 +6,7 @@
 length = 15.0
 loop = true
 tracks/0/type = "value"
-tracks/0/path = NodePath(".:rotation_degrees")
+tracks/0/path = NodePath(".:rect_rotation")
 tracks/0/interp = 1
 tracks/0/loop_wrap = true
 tracks/0/imported = false
@@ -22,7 +22,7 @@ tracks/0/keys = {
 length = 10.0
 loop = true
 tracks/0/type = "value"
-tracks/0/path = NodePath(".:scale")
+tracks/0/path = NodePath(".:rect_scale")
 tracks/0/interp = 1
 tracks/0/loop_wrap = true
 tracks/0/imported = false
@@ -34,10 +34,18 @@ tracks/0/keys = {
 "values": [ Vector2( 1, 1 ), Vector2( 7, 7 ) ]
 }
 
-[node name="SDFFontDemo" type="Node2D"]
+[node name="SDFFontDemo" type="CenterContainer"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+__meta__ = {
+"_edit_use_anchors_": false
+}
 
-[node name="Base" type="Position2D" parent="."]
-position = Vector2( 500, 300 )
+[node name="Base" type="Control" parent="."]
+margin_left = 512.0
+margin_top = 300.0
+margin_right = 512.0
+margin_bottom = 300.0
 
 [node name="Rotate" type="AnimationPlayer" parent="Base"]
 autoplay = "rotate"
@@ -48,11 +56,11 @@ anims/zoomin_zoomout = SubResource( 2 )
 autoplay = "zoomin_zoomout"
 anims/zoomin_zoomout = SubResource( 2 )
 
-[node name="Label" type="Label" parent="Base"]
-margin_left = -169.0
-margin_top = -49.0
-margin_right = 172.0
-margin_bottom = 56.0
+[node name="TextLabel" type="Label" parent="Base"]
+margin_left = -128.0
+margin_top = -50.0
+margin_right = 128.0
+margin_bottom = 51.0
 custom_fonts/font = ExtResource( 1 )
 custom_colors/font_color = Color( 0.853858, 0.771714, 0.753746, 1 )
 custom_colors/font_color_shadow = Color( 0.56592, 0.454525, 0.518426, 1 )
@@ -62,7 +70,3 @@ align = 1
 __meta__ = {
 "_edit_use_anchors_": false
 }
-
-[node name="Camera2D" type="Camera2D" parent="."]
-offset = Vector2( 512, 300 )
-current = true
diff --git a/loading/README.md b/loading/README.md
@@ -0,0 +1,7 @@
+# Loading Demos
+
+These demos demonstrate various ways to load scenes and other data.
+
+Languages: All are GDScript
+
+Renderers: All are GLES 2
diff --git a/misc/README.md b/misc/README.md
@@ -0,0 +1,10 @@
+# Miscellaneous Demos
+
+These demos don't fit into any other category, so they go into this folder.
+
+Languages: All have GDScript, OpenSimplexNoise has
+[GDSL](https://docs.godotengine.org/en/latest/tutorials/shading/shading_reference/shading_language.html),
+OS test has some
+[C#](https://docs.godotengine.org/en/latest/getting_started/scripting/c_sharp/index.html)
+
+Renderers: All are GLES 2
diff --git a/mobile/README.md b/mobile/README.md
@@ -0,0 +1,9 @@
+# Mobile Demos
+
+These demos depend on features only available in mobile phones or tablets.
+
+The Android IAP demo only runs on Android.
+
+Languages: All are GDScript
+
+Renderers: All are GLES 2
diff --git a/misc/android_iap/iap_demo.gd → mobile/android_iap/iap_demo.gd b/misc/android_iap/iap_demo.gd → mobile/android_iap/iap_demo.gd
diff --git a/misc/android_iap/icon.png → mobile/android_iap/icon.png b/misc/android_iap/icon.png → mobile/android_iap/icon.png
diff --git a/misc/multitouch_view/icon.png.import → mobile/android_iap/icon.png.import b/misc/multitouch_view/icon.png.import → mobile/android_iap/icon.png.import
diff --git a/misc/android_iap/main.tscn → mobile/android_iap/main.tscn b/misc/android_iap/main.tscn → mobile/android_iap/main.tscn
diff --git a/misc/android_iap/project.godot → mobile/android_iap/project.godot b/misc/android_iap/project.godot → mobile/android_iap/project.godot
diff --git a/misc/multitouch_cubes/CubeScene.tscn → mobile/multitouch_cubes/CubeScene.tscn b/misc/multitouch_cubes/CubeScene.tscn → mobile/multitouch_cubes/CubeScene.tscn
diff --git a/misc/multitouch_cubes/GestureArea.gd → mobile/multitouch_cubes/GestureArea.gd b/misc/multitouch_cubes/GestureArea.gd → mobile/multitouch_cubes/GestureArea.gd
diff --git a/misc/multitouch_cubes/Main.tscn → mobile/multitouch_cubes/Main.tscn b/misc/multitouch_cubes/Main.tscn → mobile/multitouch_cubes/Main.tscn
diff --git a/misc/multitouch_cubes/default_env.tres → mobile/multitouch_cubes/default_env.tres b/misc/multitouch_cubes/default_env.tres → mobile/multitouch_cubes/default_env.tres
diff --git a/misc/multitouch_cubes/icon.png → mobile/multitouch_cubes/icon.png b/misc/multitouch_cubes/icon.png → mobile/multitouch_cubes/icon.png
diff --git a/misc/regex/icon.png.import → mobile/multitouch_cubes/icon.png.import b/misc/regex/icon.png.import → mobile/multitouch_cubes/icon.png.import
diff --git a/misc/multitouch_cubes/project.godot → mobile/multitouch_cubes/project.godot b/misc/multitouch_cubes/project.godot → mobile/multitouch_cubes/project.godot
diff --git a/misc/multitouch_view/Main.gd → mobile/multitouch_view/Main.gd b/misc/multitouch_view/Main.gd → mobile/multitouch_view/Main.gd
diff --git a/misc/multitouch_view/Main.tscn → mobile/multitouch_view/Main.tscn b/misc/multitouch_view/Main.tscn → mobile/multitouch_view/Main.tscn
diff --git a/misc/multitouch_view/README.md → mobile/multitouch_view/README.md b/misc/multitouch_view/README.md → mobile/multitouch_view/README.md
diff --git a/misc/multitouch_view/TouchHelper.gd → mobile/multitouch_view/TouchHelper.gd b/misc/multitouch_view/TouchHelper.gd → mobile/multitouch_view/TouchHelper.gd
diff --git a/misc/multitouch_view/icon.png → mobile/multitouch_view/icon.png b/misc/multitouch_view/icon.png → mobile/multitouch_view/icon.png
diff --git a/misc/sensors/icon.png.import → mobile/multitouch_view/icon.png.import b/misc/sensors/icon.png.import → mobile/multitouch_view/icon.png.import
diff --git a/misc/multitouch_view/project.godot → mobile/multitouch_view/project.godot b/misc/multitouch_view/project.godot → mobile/multitouch_view/project.godot
diff --git a/misc/tween/screenshots/.gdignore → mobile/multitouch_view/screenshots/.gdignore b/misc/tween/screenshots/.gdignore → mobile/multitouch_view/screenshots/.gdignore
diff --git a/...ultitouch_view/screenshots/multitouch.png → ...ultitouch_view/screenshots/multitouch.png b/...ultitouch_view/screenshots/multitouch.png → ...ultitouch_view/screenshots/multitouch.png
diff --git a/misc/sensors/cube_6.png → mobile/sensors/cube_6.png b/misc/sensors/cube_6.png → mobile/sensors/cube_6.png
diff --git a/misc/sensors/cube_6.png.import → mobile/sensors/cube_6.png.import b/misc/sensors/cube_6.png.import → mobile/sensors/cube_6.png.import
diff --git a/misc/sensors/default_env.tres → mobile/sensors/default_env.tres b/misc/sensors/default_env.tres → mobile/sensors/default_env.tres
diff --git a/misc/sensors/icon.png → mobile/sensors/icon.png b/misc/sensors/icon.png → mobile/sensors/icon.png
diff --git a/misc/tween/icon.png.import → mobile/sensors/icon.png.import b/misc/tween/icon.png.import → mobile/sensors/icon.png.import
diff --git a/misc/sensors/main.gd → mobile/sensors/main.gd b/misc/sensors/main.gd → mobile/sensors/main.gd
diff --git a/misc/sensors/main.tscn → mobile/sensors/main.tscn b/misc/sensors/main.tscn → mobile/sensors/main.tscn
diff --git a/misc/sensors/project.godot → mobile/sensors/project.godot b/misc/sensors/project.godot → mobile/sensors/project.godot
diff --git a/mono/README.md b/mono/README.md
@@ -1,3 +1,13 @@
+# Mono Demos
+
+These demos are written in [C#](https://docs.godotengine.org/en/latest/getting_started/scripting/c_sharp/index.html).
+You must have the Mono version of Godot to run these.
+
+Languages: All have [C#](https://docs.godotengine.org/en/latest/getting_started/scripting/c_sharp/index.html),
+2.5D has some GDScript
+
+Renderers: Dodge the Creeps is GLES 3, rest are GLES 2
+
 # Note: Godot 3.2.2 or newer is required
 
 While most of the demos work with any 3.2.x version, these demos require

diff --git a/networking/README.md b/networking/README.md
@@ -0,0 +1,7 @@
+# Networking Demos
+
+These demos showcase networking and/or multiplayer features.
+
+Languages: All have GDScript, WebRTC uses some GDNative
+
+Renderers: Multiplayer Bomber is GLES 3, rest are GLES 2
diff --git a/networking/multiplayer_bomber/README.md b/networking/multiplayer_bomber/README.md
@@ -6,7 +6,7 @@ should type in his address and press "play".
 
 Language: GDScript
 
-Renderer: GLES 2
+Renderer: GLES 3
 
 ## Screenshots
 

diff --git a/viewport/README.md b/viewport/README.md
@@ -0,0 +1,9 @@
+# Viewport Demos
+
+These demos showcase various ways to use the
+[`Viewport`](https://docs.godotengine.org/en/stable/classes/class_viewport.html) node.
+
+Languages: All have GDScript, Dynamic Split Screen has
+[GDSL](https://docs.godotengine.org/en/latest/tutorials/shading/shading_reference/shading_language.html)
+
+Renderers: 3D in 2D and GUI in 3D use GLES 3, the rest are GLES 2
diff --git a/visual_script/README.md b/visual_script/README.md
@@ -0,0 +1,8 @@
+# VisualScript Demos
+
+These demos are written in [VisualScript](https://docs.godotengine.org/en/latest/getting_started/scripting/visual_script/index.html).
+
+Languages: All are [VisualScript](https://docs.godotengine.org/en/latest/getting_started/scripting/visual_script/index.html),
+Multitouch View has some GDScript
+
+Renderers: All are GLES 2
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,3 @@ singletons=[ ]
		[rendering]

		environment/default_clear_color=Color( 0.18, 0.1188, 0.15348, 1 )
		environment/default_environment="res://default_environment.tres"