From 8caef0f8a346bbd726c5f296933b663e22ac4d28 Mon Sep 17 00:00:00 2001 From: Edvin Jakobsson Date: Tue, 8 Sep 2026 19:55:43 +0200 Subject: Tweak README wording --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 11ebebd..9bb9831 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # nships -An attempt at networked Battleship over ncurses — host a game on a raw TCP socket (`server.c`, a plain `socket`/`bind`/`listen`/`accept` pair on port 8888) or join one by IP, trade names, then place ships on your own board before taking turns firing at your opponent's. +An attempt at networked Battleship over ncurses. Host a game on a raw TCP socket (`server.c`, a plain `socket`/`bind`/`listen`/`accept` pair on port 8888) or join one by IP, trade names, then place ships on your own board before taking turns firing at your opponent's. -Ship placement works: you move a ship around with WASD, rotate it, and lock it in, five ships per side. Turn-taking mostly works too — coordinates get sent and received over the socket so each player sees where the other is aiming. What never got finished is syncing the actual board state itself: the code that's supposed to exchange each player's ship layout after placement is stubbed out as comments ("send to p1" / "recieve p1"), so a real game currently plays blind past the placement phase. +Ship placement works: you move a ship around with WASD, rotate it, and lock it in, five ships per side. Turn-taking mostly works too, since coordinates get sent and received over the socket so each player sees where the other is aiming. What never got finished is syncing the actual board state itself. The code that's supposed to exchange each player's ship layout after placement is stubbed out as comments ("send to p1" / "recieve p1"), so a real game currently plays blind past the placement phase. -Worth knowing before you try to build it: `nships.c` still has an unresolved merge-conflict block sitting in `setPlace()` (`<<<<<<< HEAD` / `=======` / `>>>>>>> origin/main`) from whatever merge originally introduced it — that history got carried over intact rather than cleaned up, so it needs a manual pick before this will compile. +Worth knowing before you try to build it: `nships.c` still has an unresolved merge-conflict block sitting in `setPlace()` (`<<<<<<< HEAD` / `=======` / `>>>>>>> origin/main`) from whatever merge originally introduced it. That history got carried over intact rather than cleaned up, so it needs a manual pick before this will compile. ## Controls Ship placement: -- `W`/`A`/`S`/`D` — move the ship -- `R` — rotate -- `Enter` — lock it in +- `W`/`A`/`S`/`D`: move the ship +- `R`: rotate +- `Enter`: lock it in Firing: -- `W`/`A`/`S`/`D` — move the cursor -- `Enter` — fire +- `W`/`A`/`S`/`D`: move the cursor +- `Enter`: fire ## Building -- cgit v1.2.3