浏览代码

Add README to the 2D platformer

Nathan Lovato 5 年之前
父节点
当前提交
263bfd8bd3
共有 1 个文件被更改,包括 25 次插入0 次删除
  1. 25 0
      2d/platformer/README.md

+ 25 - 0
2d/platformer/README.md

@@ -0,0 +1,25 @@
+# 2D Platformer #
+
+This demo is a pixel art 2D platformer with graphics and sound.
+
+It shows you how to code characters and physics-based objects in a real game context. This is a relatively complete demo where the player can jump, walk on slopes, fire bullets, interact with enemies, and more. It contains one closed level, and the player is invincible, unlike the enemies.
+
+You will find most of the demo’s content in the `Level.tscn`. You can open it from the default `Game.tscn` scene, or double click on `Level.tscn` in the `src/Level/` directory.
+
+We invite you to open the demo's GDScript files in the editor as they contain a lot of comments that explain how each class works.
+
+## Features ##
+
+- Side-scrolling player controller.
+    - Can walk on and snap to slopes.
+    - Can shoot, including while jumping.
+- Enemies that crawl on the floor and change direction when they encounter an obstacle.
+- Camera that stays within the level’s bounds.
+- Supports keyboard and gamepad controls.
+- Platforms that can move in any direction.
+- Gun that shoots bullets with rigid body (natural) physics.
+- Collectible coins.
+- Pause and pause menu.
+- Pixel art visuals.
+- Sound effects and music.
+