Update README.md

Author: Tanish-Desai

README.md

@@ -1,13 +1,75 @@
-# gaem
-my first game using Godot 😀!
+# Dot Knight
 
-As of now (*Full Init*), the game has the player node and the map tilesets. 
+**A simple Godot-based metroidvania with a knight**
 
-Physics have been added, and a raw design of the map is done.
-More is to be done. 
+Small 2D platformer/metroidvania prototype built in Godot. It features a controllable knight character, enemies, coins, platforms, background art and music, and a basic scoring system. The project is actively being developed — recent commits add animations, SFX, score mechanics, and map polish.
 
-**UPDATE:27|12|24**
-The game is almost completed at its most basic level.
-There are enemies, a larger map, background art, bg music, sfx, and different sprite animations. Not to mention even a dynamic scoreboard is added.
+---
 
-More features are to be added!
+## Features
+
+* Player movement: walk, run, jump, and directional controls (WASD or arrow keys).
+* Player animations: idle, run, jump, hurt, and death animations (recent additions).
+* Sound: background music autoplays; jump, damage, and coin pickup SFX.
+* Gameplay elements: platforms, coins with pickup animation, enemies, and a killzone under the map.
+* Dynamic score text / scoreboard that updates when collecting coins.
+* Text hints and calibrated death animations for clearer feedback.
+
+---
+
+## Controls
+
+* Move left / right: `A` / `D` or `←` / `→`
+* Jump: `W` or `↑`
+
+> The project uses the Godot InputMap. If you want to change controls, open the project in Godot and edit **Project → Project Settings → Input Map**.
+
+---
+
+## How to run (quick)
+
+1. Install Godot Engine (recommended: latest stable Godot 4.x). If you only have Godot 3.x and run into issues, try Godot 4 or check for scene format differences.
+2. Clone the repo:
+
+```bash
+git clone https://github.com/Tanish-Desai/Dot-Knight.git
+cd Dot-Knight
+```
+
+3. Open the project folder in Godot by selecting the folder that contains `project.godot`.
+4. Open the main scene (usually the top-level scene under `scenes/` — look for a file named like `Main.tscn` or `level.tscn`) and press Play.
+
+**Exporting:** To create a runnable executable for Windows/Linux/macOS, install Godot export templates and use **Project → Export**.
+
+---
+
+## Gameplay / Objectives
+
+* Explore the level(s) as the knight.
+* Collect coins to increase your score (animated pickups indicate successful collection).
+* Avoid enemies and falling into the killzone (instant death).
+* Use movement and platforming skills to access different map areas.
+
+---
+
+## Project structure (high level)
+
+* `scenes/` — Godot scenes (levels, player scene, UI, enemies, etc.)
+* `scripts/` — GDScript files that control player, coins, enemies and game logic
+* `assets/` — sprites, audio (bg music & sfx), tilesets, animations
+* `project.godot` — Godot project file
+
+---
+
+## Known issues & TODO
+
+* More polish on level design and enemy variety.
+* Add player abilities (double-jump, dash, attack) and a proper health system.
+* Save/load and multiple levels with checkpoints.
+* Improve UI (main menu, pause, settings) and add an options screen for remapping keys.
+  
+---
+
+## Assets & Credits
+
+* All sprites, music and SFX used in the repo are from [Brackeys' Platformer Bundle](https://brackeysgames.itch.io/brackeys-platformer-bundle)