From 78b8225fc7cc43098322f01a0f1ac415690f2869 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jayyy=20=E2=8B=86=CB=9A=E2=9C=BF=CB=96=C2=B0?= <192614765+kodzukye@users.noreply.github.com> Date: Sun, 26 Apr 2026 08:50:34 -0400 Subject: [PATCH] docs: add README - Add project description, controls, built with section - Add local setup instructions - Add MIT license reference and itch.io link placeholder --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..980dee5 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# SCRAP SIGNAL + +> *SCRAP-09 wakes up, 847 days have passed. The factory is silent, the humans are gone but some of the machines are still running.* + +A top-down 2D narrative exploration game made for **Gamedev.js Jam 2026** (Theme: Machines). + +**[▶ Play it on itch.io](https://kodzukye.itch.io/scrap-signal)** + +*** + +## About + +You play as **SCRAP-09**, a maintenance robot who wakes up in an abandoned industrial factory with no memory of what happened. Explore three zones, scavenge for parts, repair the robots left behind and uncover the truth about why the humans left. + +- 3 zones to explore : Warehouse, Workshop, Courtyard +- Circuit wire-connecting repair mini-game +- 2 NPCs with their own stories (VRAC-7, IRIS-3) +- Narrative told through system logs and journal fragments +- 2 endings depending on your choices +- ~5 minutes per run + +## Controls + +| Key | Action | +|---|---| +| `WASD` / Arrow keys | Move | +| `E` | Interact / Repair / Read | +| `Escape` | Cancel / Close mini-game | + +## Built With + +- [Godot 4.6](https://godotengine.org/) — Game engine +- GDScript — Scripting +- Aseprite — Pixel art (32×32 sprites) + +## Running Locally + +1. Download and install [Godot 4.6](https://godotengine.org/download) +2. Clone this repository +3. Open `project.godot` in Godot +4. Press `F5` to run + +## License + +MIT — see [LICENSE](LICENSE) + +*** + +*Made in 13 days for [Gamedev.js Jam 2026](https://itch.io/jam/gamedevjs-2026)*