Pārlūkot izejas kodu

Add screenshots and tweak README files

Aaron Franke 5 gadi atpakaļ
vecāks
revīzija
c7cc72b705

+ 19 - 7
misc/2.5d/README.md

@@ -1,19 +1,31 @@
 # 2.5D Demo Project (GDScript)
 
-This demo project is an example of how a 2.5D game could be created in Godot.
-
-Controls: WASD to move, Space to jump, R to reset, and UIOPKL to change view modes.
+This demo project shows a way to create a 2.5D game in Godot by mixing 2D and 3D nodes. It also adds a 2.5D editor viewport for easily editing 2.5D levels.
 
 Note: There is a Mono C# version available [here](https://github.com/godotengine/godot-demo-projects/tree/master/mono/2.5d).
 
 ## How does it work?
 
-Custom node types are added in a Godot plugin to allow 2.5D objects. Node25D serves as the base for all 2.5D objects; its first child must be a Spatial, which is used to calculate its position. It also adds YSort25D to sort Node25D nodes, and ShadowMath25D for calculating a shadow (a simple KinematicBody that tries to cast downward).
+Custom node types are added in a Godot plugin to allow 2.5D objects. Node25D serves as the base for all 2.5D objects. Its first child must be a 3D Spatial, which is used to calculate its position. Then, add a 2D Sprite (or similar) to display the object.
 
-It uses math inside of Node25D to calculate 2D positions from 3D ones. For getting a 3D position, this project uses KinematicBody and StaticBody (3D), but these only exist for math - the camera is 2D and all sprites are 2D. You are able to use any Spatial node for math.
+Inside of Node25D, a 2.5D transformation matrix made of three Vector2 is used to calculate the 2D position from the 3D position. For getting a 3D position, this project uses KinematicBody and StaticBody (3D), but these only exist for math - the camera is 2D and all sprites are 2D. You are able to use any Spatial node for math.
 
-To display the objects, add a Sprite or any other Node2D-derived children to your Node25D objects. Some nodes are unsuitable, such as 2D physics nodes. Keep in mind that the first child must be Spatial-derived for math purposes.
+Several view modes are implemented, including top down, front side, 45 degree, isometric, and two oblique modes. To implement a different view angle, all you need to do is create a new set of basis vectors in Node25D, use it on all instances, and of course create sprites to display that object in 2D.
 
-Several view modes are implemented, including top down, front side, 45 degree, isometric, and two oblique modes. To implement a different view angle, all you need to do is create a new set of basis vectors in Node25D, use it on all instances, and of course create textures to display that object in 2D.
+The plugin also adds YSort25D to sort Node25D nodes, and ShadowMath25D for calculating a shadow (a simple KinematicBody that tries to cast downward).
 
 ## Screenshots
+
+![Forty Five Degrees](screenshots/forty_five.png)
+
+![Isometric](screenshots/isometric.png)
+
+![Oblique Z](screenshots/oblique_z.png)
+
+![Oblique Y](screenshots/oblique_y.png)
+
+![Front Side](screenshots/front_side.png)
+
+![Cube](screenshots/cube.png)
+
+![2.5D Editor Viewport](screenshots/editor.png)

+ 0 - 0
misc/2.5d/screenshots/.gdignore


BIN
misc/2.5d/screenshots/cube.png


BIN
misc/2.5d/screenshots/editor.png


BIN
misc/2.5d/screenshots/forty_five.png


BIN
misc/2.5d/screenshots/front_side.png


BIN
misc/2.5d/screenshots/isometric.png


BIN
misc/2.5d/screenshots/oblique_y.png


BIN
misc/2.5d/screenshots/oblique_z.png


+ 19 - 7
mono/2.5d/README.md

@@ -1,19 +1,31 @@
 # 2.5D Demo Project (Mono C#)
 
-This demo project is an example of how a 2.5D game could be created in Godot.
-
-Controls: WASD to move, Space to jump, R to reset, and UIOPKL to change view modes.
+This demo project shows a way to create a 2.5D game in Godot by mixing 2D and 3D nodes. It also adds a 2.5D editor viewport for easily editing 2.5D levels.
 
 Note: There is a GDScript version available [here](https://github.com/godotengine/godot-demo-projects/tree/master/misc/2.5d).
 
 ## How does it work?
 
-Custom node types are added in a Godot plugin to allow 2.5D objects. Node25D serves as the base for all 2.5D objects; its first child must be a Spatial, which is used to calculate its position. It also adds YSort25D to sort Node25D nodes, and ShadowMath25D for calculating a shadow.
+Custom node types are added in a Godot plugin to allow 2.5D objects. Node25D serves as the base for all 2.5D objects. Its first child must be a 3D Spatial, which is used to calculate its position. Then, add a 2D Sprite (or similar) to display the object.
 
-It uses structs called Basis25D and Transform25D to calculate 2D positions from 3D ones. For getting a 3D position, this project uses KinematicBody and StaticBody (3D), but these only exist for math - the camera is 2D and all sprites are 2D. You are able to use any Spatial node for math.
+Inside of Node25D, new structs called Basis25D and Transform25D are used to calculate the 2D position from the 3D position. For getting a 3D position, this project uses KinematicBody and StaticBody (3D), but these only exist for math - the camera is 2D and all sprites are 2D. You are able to use any Spatial node for math.
 
-To display the objects, add a Sprite or any other Node2D-derived children to your Node25D objects. Some nodes are unsuitable, such as 2D physics nodes. Keep in mind that the first child must be Spatial-derived for math purposes.
+Several view modes are implemented, including top down, front side, 45 degree, isometric, and two oblique modes. To implement a different view angle, all you need to do is create a new Basis25D, use it in all your Node25D transforms, and of course create sprites to display that object in 2D.
 
-Several view modes are implemented, including top down, front side, 45 degree, isometric, and two oblique modes. To implement a different view angle, all you need to do is create a new Basis25D, use it in all your Node25D transforms, and of course create textures to display that object in 2D.
+The plugin also adds YSort25D to sort Node25D nodes, and ShadowMath25D for calculating a shadow (a simple KinematicBody that tries to cast downward).
 
 ## Screenshots
+
+![Forty Five Degrees](../../misc/2.5d/screenshots/forty_five.png)
+
+![Isometric](../../misc/2.5d/screenshots/isometric.png)
+
+![Oblique Z](../../misc/2.5d/screenshots/oblique_z.png)
+
+![Oblique Y](../../misc/2.5d/screenshots/oblique_y.png)
+
+![Front Side](../../misc/2.5d/screenshots/front_side.png)
+
+![Cube](../../misc/2.5d/screenshots/cube.png)
+
+![2.5D Editor Viewport](../../misc/2.5d/screenshots/editor.png)