Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aahan0511 committed Jan 1, 2025
1 parent bcff1b9 commit e3972a3
Showing 1 changed file with 86 additions and 0 deletions.
86 changes: 86 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<div align="center">

[<img src="https://github.com/aahan0511/the2048game/blob/main/assets/images/icon.png" alt="assets/images/icon.png" width=110>](https://github.com/aahan0511/the2048game "the2048game on GitHub")

# [**`the2048game`**](https://github.com/aahan0511/the2048game "the2048game on GitHub")

### **`2048`**
**2048** is a *single*-player sliding tile puzzle video game. Its objective is to slide numbered tiles on a *4x4* grid to combine them and create a tile with the number `2048`.

---

<br><br>

# **`Contents`**
</div>

* [**`How To Play`**](https://github.com/aahan0511/the2048game?tab=readme-ov-file#how-to-play)
* [**`Status`**](https://github.com/aahan0511/the2048game?tab=readme-ov-file#status)
* [**`License`**](https://github.com/aahan0511/the2048game?tab=readme-ov-file#license)
* [**`Credit`**](https://github.com/aahan0511/the2048game?tab=readme-ov-file#credit)
* [**`Contributing`**](https://github.com/aahan0511/the2048game?tab=readme-ov-file#contributing)
* [**`Code Of Conduct`**](https://github.com/aahan0511/the2048game?tab=readme-ov-file#code-of-conduct)

<br><br>
<div align="center">

# **`How To Play`**

</div>

- **Start the Game**: Begin with a 4x4 grid containing two numbered tiles, usually 2s or 4s. Your goal is to combine these tiles to create a tile with the number 2048.
- **Move Tiles**: Use the arrow keys (or W, A, S, D on a keyboard) to move all tiles on the grid in the chosen direction. When two tiles with the same number touch, they merge into one tile with the sum of their values.
- **New Tiles**: After each move, a new tile (either 2 or 4) randomly appears on an empty space on the grid.
- **Continue Playing**: You can continue playing after reaching 2048, aiming for even higher numbers. The game ends when no more moves are possible, meaning the grid is full and no tiles can combine.

<br><br>
<div align="center">

# **`Status`**
</div>

> [!IMPORTANT]
> **the2048game** is currently only for windows, it may work for other operating systems after some changes, but it may not work as intended.
<br><br>
<div align="center">

# [**`License`**](https://opensource.org/license/mit "OpenSource.org Website")

</div>

the2048game is licensed under the [**MIT License**](https://github.com/aahan0511/the2048game/blob/main/LICENSE.md "License for the2048game").

<br><br>
<div align="center">

# **`Credit`**

</div>

## JetBrains Mono
Thanks to [JetBrains](https://github.com/JetBrains "JetBrains on GitHub"), for providing the [JetBrains Mono](https://github.com/JetBrains/JetBrainsMono) font.

## Python Modules
Thanks to on the [modules](https://github.com/aahan0511/the2048game/requirements.txt) on which Othello is built on.

## Original Game
Thanks to **Gabriele Cirulli** who is an Italian freelance programmer, who also developed the game as a *weekend project*.

<br><br>
<div align="center">

# [**`Contributing`**](https://github.com/aahan0511/the2048game/blob/main/.github/CONTRIBUTING.md "Contributing on Othello")

</div>

Follow the [CONTRIBUTING.md](https://github.com/aahan0511/the2048game/blob/main/.github/CONTRIBUTING.md "Contributing for Othello") to ensure a smooth contribution process.

<br><br>
<div align="center">

# [**`Code Of Conduct`**](https://www.contributor-covenant.org/ "Contributor Covenant Website")

</div>

Othello has the [**Contributor Covenant Code of Conduct**](https://github.com/aahan0511/the2048game/blob/main/.github/CODE_OF_CONDUCT.md "Code Of Conduct for Othello").

0 comments on commit e3972a3

Please sign in to comment.