Skip to content

Commit d6d033c

Browse files
committed
added readme
1 parent f3f4637 commit d6d033c

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Tile Puzzle Game
2+
3+
A classic sliding tile puzzle game built with **Rust** and **SDL2**. Rearrange the tiles to recreate the image using your keyboard's arrow keys!
4+
5+
## 🕹️ How to Play
6+
- Use the **Arrow Keys** to move the tiles into the empty space.
7+
- Press **H** for Help.
8+
- Arrange the tiles correctly to win!
9+
10+
## 📸 Screenshot
11+
![Gameplay Screenshot](assets/screenshot.png)
12+
13+
## ⚙️ Features
14+
- Keyboard-based controls.
15+
- Help screen for guidance.
16+
- Clear win condition.
17+
18+
## 🛠️ Built With
19+
- **Rust**: For high-performance game logic.
20+
- **SDL2**: For rendering graphics and handling user input.
21+
22+
## 🚀 Getting Started
23+
### Prerequisites
24+
Ensure you have the following installed:
25+
- Rust
26+
- SDL2 library
27+
28+
### Installation
29+
1. Clone the repository:
30+
```bash
31+
git clone https://github.com/rubbieKelvin/rusty-slides.git
32+
cd rusty-slides
33+
```
34+
2. Build the project:
35+
```bash
36+
cargo build --release
37+
```
38+
3. Run the game:
39+
```bash
40+
cargo run --release
41+
```
42+
43+
## 🧩 Future Improvements
44+
- Tile sliding animations.
45+
- Multiple difficulty levels.
46+
- Timer and scoring system.
47+
48+
## 🤝 Contributing
49+
Feel free to fork this project and submit a pull request with improvements or bug fixes.
50+
51+
## 📄 License
52+
This project is licensed under the **MIT License**.
53+
54+
## 📬 Contact
55+
For any questions or suggestions, reach out at **[email protected]**.
56+
57+
Enjoy the game and happy puzzling! 🎮✨
58+

assets/screenshot.png

263 KB
Loading

0 commit comments

Comments
 (0)