Add README files to 3D demos

This commit is contained in:
Aaron Franke
2020-03-07 20:29:42 -05:00
parent a24ac796b6
commit 7e0032eb8e
26 changed files with 124 additions and 4 deletions

22
3d/ik/README.md Normal file
View File

@@ -0,0 +1,22 @@
# 3D Inverse Kinematics
This is an example of different Inverse Kinematic algorithms
implemented in Godot. It contains four scenes, showing
different ways they can be used.
Language: GDScript
Renderer: GLES 3
## How does it work?
This demo shows how to implement IK using two different methods. One uses the
[`SkeletonIK`](https://docs.godotengine.org/en/latest/classes/class_skeletonik.html)
node which is built into Godot. The other method is using a script
called FABRIK (inside of the SADE plugin) for inverse kinematics.
## Screenshots
![Screenshot](screenshots/cube.png)
![Screenshot](screenshots/fps_gun.png)

View File

@@ -15,7 +15,7 @@ _global_script_class_icons={
[application]
config/name="3D IK"
config/name="3D Inverse Kinematics"
run/main_scene="res://look_at_ik.tscn"
config/icon="res://icon.png"

View File

BIN
3d/ik/screenshots/cube.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 222 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

View File

@@ -0,0 +1,21 @@
# 3D Kinematic Character
Kinematic character demo for 3D using a cube for the character.
This is similar to the 2D platformer demo.
Language: GDScript
Renderer: GLES 3
## How does it work?
This demo uses a [`KinematicBody`](https://docs.godotengine.org/en/latest/classes/class_kinematicbody.html)
for the player, and [`StaticBody`](https://docs.godotengine.org/en/latest/classes/class_staticbody.html)
for the level. Each has colliders, the player moves itself via
`move_and_slide()` in `_physics_process()`, and collides with the level.
## Screenshots
![Screenshot](screenshots/ingame.png)
![Screenshot](screenshots/editor.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 337 KiB

View File

@@ -0,0 +1,17 @@
# Material Testers
This demo includes many sphere-like objects with complex materials,
for the purpose of showcasing Godot's rendering capabilities.
This demo was featured at the beginning of the
[Godot 3.0 trailer](https://www.youtube.com/watch?v=XptlVErsL-o).
Language: GDScript
Renderer: GLES 3
## Screenshots
![Screenshot](screenshots/stones.png)
![Screenshot](screenshots/mirror.png)

View File

@@ -15,7 +15,7 @@ _global_script_class_icons={
[application]
config/name="Material Tester"
config/name="Material Testers"
run/main_scene="res://material_tester.tscn"
config/icon="res://icon.png"
@@ -36,4 +36,3 @@ multithread/thread_rid_pool_prealloc=60
vram_compression/import_etc2=false
quality/filters/msaa=2
environment/default_environment="res://default_env.tres"

Binary file not shown.

After

Width:  |  Height:  |  Size: 507 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 408 KiB

14
3d/navmesh/README.md Normal file
View File

@@ -0,0 +1,14 @@
# 3D Navigation Mesh
Navigation mesh demo for 3D scenes, with a character
able to pathfind around a complex 3D environment.
The navigation path is drawn using a line.
Code is provided for polyline following in 3D.
Language: GDScript
Renderer: GLES 3
## Screenshots
![Screenshot](screenshots/nav.png)

View File

@@ -15,7 +15,7 @@ _global_script_class_icons={
[application]
config/name="Navmesh Demo"
config/name="3D Navigation Mesh"
run/main_scene="res://navmesh.tscn"
config/icon="res://icon.png"

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

16
3d/platformer/README.md Normal file
View File

@@ -0,0 +1,16 @@
# 3D Platformer
3D Platformer demo using a
[`KinematicBody`](https://docs.godotengine.org/en/latest/classes/class_kinematicbody.html).
It uses similar code to the 2D platformer, but implemented in 3D.
It also features audio reverberation (it sounds echo-y).
Language: GDScript
Renderer: GLES 3
## Screenshots
![Screenshot](screenshots/face.png)
![Screenshot](screenshots/shoot.png)

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 424 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 623 KiB

27
3d/truck_town/README.md Normal file
View File

@@ -0,0 +1,27 @@
# Truck Town
This is a demo implementing different types of trucks of
varying complexity using vehicle physics.
Do not be surprised if everything is bouncy and glitchy,
Godot's physics system is not polished and will likely be
reworked in the future.
Language: GDScript
Renderer: GLES 2
## How does it work?
The base vehicle uses a
[`VehicleBody`](https://docs.godotengine.org/en/latest/classes/class_vehiclebody.html)
node. The trailer truck is tied together using a
[`ConeJointTwist`](https://docs.godotengine.org/en/latest/classes/class_conetwistjoint.html)
node, and the tow truck is tried together using a chain made of
[`RigidBody`](https://docs.godotengine.org/en/latest/classes/class_rigidbody.html)
nodes which are pinned together using
[`PinJoint`](https://docs.godotengine.org/en/latest/classes/class_pinjoint.html) nodes.
## Screenshots
![Screenshot](screenshots/tow.png)

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 409 KiB