r2048 0.1.3

2048 written in rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# r2048

[![Linux Build](https://github.com/asaft29/r2048/actions/workflows/linux.yml/badge.svg)](https://github.com/asaft29/r2048/actions/workflows/linux.yml)
[![macOS Build](https://github.com/asaft29/r2048/actions/workflows/macos.yml/badge.svg)](https://github.com/asaft29/r2048/actions/workflows/macos.yml)
[![Windows Build](https://github.com/asaft29/r2048/actions/workflows/windows.yml/badge.svg)](https://github.com/asaft29/r2048/actions/workflows/windows.yml)
[![Crates.io](https://img.shields.io/crates/v/r2048.svg)](https://crates.io/crates/r2048)
<p align="center">
  <img src="doc/demo.gif" alt="r2048 Demo" width="600"><br><br>
  r2048 is a terminal version of the classic 2048 game, built in Rust using the <a href="https://github.com/ratatui-org/ratatui">ratatui</a> crate for the UI design.
</p>



## Preview

<br>

<p align="center">
  <img src="doc/menu.png" alt="Menu screen" width="500"><br>
  <strong>Menu</strong>
</p>
<p align="center">
  <img src="doc/playing.png" alt="Mid-game action with colorful tiles" width="500"><br>
  <strong>Mid-game</strong>
</p>
<p align="center">
  <img src="doc/winning.png" alt="Victory screen celebration" width="500"><br>
 ʕ·͡ᴥ·ʔ <strong>Winning</strong> ʕ·͡ᴥ·ʔ
</p>
<p align="center">
  <img src="doc/game_over.png" alt="Game over screen" width="500"><br>
  ಡ_ಡ <strong>Losing</strong> ಡ_ಡ
</p>

<br>

## Controls That Just Make Sense


### Main Menu

- `←` / `→` – Browse your options like a pro
- `E` – Dive into the action
- `Q` or `Esc` – Exit the game gracefully

### In the Game

- `↑` / `↓` / `←` / `→` – Slide those tiles with precision
- `Q` or `Esc` – Takes you back to the menu when things get tough
- `Ctrl + C` – Nuclear option (closes everything immediately)

<br>

## Score Persistence 


High scores now persist between sessions thanks to a built-in [SQLite](https://docs.rs/rusqlite/latest/rusqlite/) database.

Whether you quit the game, close your terminal, or reboot your machine, your top scores are safely stored — no setup required.

Each user has a separate score history, so you can challenge friends on the same machine without stepping on each other’s records. It’s simple, fast, and completely local.

<br>

## Development Notes


- **C++ Background:** Coming from C++, Rust’s borrow checker encouraged cleaner, safer code structure.  

- **State Machine:** Using enums and pattern matching, the game’s states (`Menu`, `Playing`, `Won`, `GameOver`) are clear and type-safe.  

- **Game Logic:** Implementing merge rules correctly without double merges was the trickiest part — it took several rewrites to get right.  
ker encouraged 
- **Code Quality:** Rust’s strictness helped catch subtle edge cases and improved overall code reliability.

<br>

## Getting Started


### 1. Via [crates.io](https://crates.io/crates/r2048):

If Rust is installed and you don't want to clone the repo, consider using `cargo install`
```bash
cargo install r2048

r2048
```
> Note: Running the game this way will create a SQLite database in the folder where r2048 is executed to store high scores

### 2. Build it yourself


First, make sure you have Rust installed on your system. If not, grab it from [rust-lang.org](https://www.rust-lang.org/tools/install) – it's surprisingly painless.

```bash
# Clone the repo

git clone https://github.com/asaft29/r2048.git

cd r2048

# Run it immediately with no verbose output showing (Cargo will handle the build)

cargo run --release 
```

### Warning


> There are some potential issues with `cargo install` if you are on **Windows**  

- `stdarg.h` missing → install C++ build tools + Windows SDK  
- `libsqlite3-sys` fails → MSVC headers required