Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rubbieKelvin committed Jan 1, 2025
1 parent f3f4637 commit d6d033c
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Tile Puzzle Game

A classic sliding tile puzzle game built with **Rust** and **SDL2**. Rearrange the tiles to recreate the image using your keyboard's arrow keys!

## 🕹️ How to Play
- Use the **Arrow Keys** to move the tiles into the empty space.
- Press **H** for Help.
- Arrange the tiles correctly to win!

## 📸 Screenshot
![Gameplay Screenshot](assets/screenshot.png)

## ⚙️ Features
- Keyboard-based controls.
- Help screen for guidance.
- Clear win condition.

## 🛠️ Built With
- **Rust**: For high-performance game logic.
- **SDL2**: For rendering graphics and handling user input.

## 🚀 Getting Started
### Prerequisites
Ensure you have the following installed:
- Rust
- SDL2 library

### Installation
1. Clone the repository:
```bash
git clone https://github.com/rubbieKelvin/rusty-slides.git
cd rusty-slides
```
2. Build the project:
```bash
cargo build --release
```
3. Run the game:
```bash
cargo run --release
```

## 🧩 Future Improvements
- Tile sliding animations.
- Multiple difficulty levels.
- Timer and scoring system.

## 🤝 Contributing
Feel free to fork this project and submit a pull request with improvements or bug fixes.

## 📄 License
This project is licensed under the **MIT License**.

## 📬 Contact
For any questions or suggestions, reach out at **[email protected]**.

Enjoy the game and happy puzzling! 🎮✨

Binary file added assets/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d6d033c

Please sign in to comment.