Skip to content
This repository has been archived by the owner on Jul 7, 2024. It is now read-only.

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShenMian committed Apr 19, 2024
1 parent 8d8e831 commit 65ea39d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![CodeFactor](https://www.codefactor.io/repository/github/shenmian/gomoku/badge)](https://www.codefactor.io/repository/github/shenmian/gomoku)

A simple gomoku, using [SFML] framework, supports mouse/keyboard/controller input and LAN connection.
A simple gomoku, using [SFML] framework, supports mouse/keyboard and controller input, and offers both offline and LAN multiplayer modes.

<p align="center"><img src="docs/screenshot.png" width=50% height=50%></p>

Expand All @@ -12,24 +12,24 @@ The rules are **free-style** and there are no forbidden moves. Players can decid

## Modes

- Online: one person acts as a server and the other as a client to play games online.
- Offline: playing games in turns with two players in an offline environment.
- **Online**: One player serves as the host while the other joins as a client, allowing games to be played over a local network.
- **Offline**: Two players take turns playing the game locally.

## Keymap

### Keyboard

| Key | Action |
| ------------------------------------------ | --------------- |
| `Space` | Place chess |
| `Space` | Place piece |
| `Backspace` | Undo |
| `W`/`A`/`S`/`D`/`Up`/`Down`/`Left`/`Right` | Move the cursor |

### Controller

| Key | Action |
| ------------ | --------------- |
| `A`/`Cross` | Place chess |
| `A`/`Cross` | Place piece |
| `B`/`Circle` | Undo |
| D-pad | Move the cursor |

Expand Down

0 comments on commit 65ea39d

Please sign in to comment.