Skip to content

Commit

Permalink
docs: replace crate with box in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShenMian committed Jun 13, 2024
1 parent db398a2 commit b7d9668
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ A sokoban with solver.

<p align="center"><img src="./docs/assets/auto_solve.gif" width=50%></p>

- **Auto move**: Supports full mouse control for automatic player movement and crate pushing. [More details](docs/auto_move.md).
- **Auto move**: Supports full mouse control for automatic player movement and box pushing. [More details](docs/auto_move.md).

<p align="center"><img src="./docs/assets/auto_crate_push.gif" width=50%></p>
<p align="center"><img src="./docs/assets/auto_box_push.gif" width=50%></p>

- **Level management**: Levels and solutions are stored in the database. [More details](docs/level_management.md).
- **Customizing**: Options can be customized via configuration file. [More details](docs/customizing.md).
Expand All @@ -27,15 +27,15 @@ A sokoban with solver.

### Mouse

| Key | Action |
| ------------------------------------- | ---------------------------------------- |
| Click `Left` on player reachable area | Move the character to this position |
| Click `Left` on a crate | Show the pushable area of the crate |
| Click `Left` on crate pushable area | Push the selected crate to this position |
| Hold `Right` and drag | Adjust viewport |
| Click `Button 4` | Undo the last push |
| Click `Button 5` | Redo the last push |
| Scroll `Middle` | Zoom in/out |
| Key | Action |
| ------------------------------------- | -------------------------------------- |
| Click `Left` on player reachable area | Move the character to this position |
| Click `Left` on a box | Show the pushable area of the box |
| Click `Left` on box pushable area | Push the selected box to this position |
| Hold `Right` and drag | Adjust viewport |
| Click `Button 4` | Undo the last push |
| Click `Button 5` | Redo the last push |
| Scroll `Middle` | Zoom in/out |

### Keyboard

Expand Down Expand Up @@ -76,4 +76,4 @@ A sokoban with solver.
| `X`/`Square` | Toggle instant move[^1] |
| `Y`/`Triangle` | Toggle automatic solution |

[^1]: Turn off character and crates movement animations.
[^1]: Turn off character and boxes movement animations.

0 comments on commit b7d9668

Please sign in to comment.