Skip to content

Latest commit

 

History

History
158 lines (111 loc) · 6.84 KB

README.md

File metadata and controls

158 lines (111 loc) · 6.84 KB

the2048game

This is the Python clone for 2048.

Table Of Contents

Status

Note

The project is not production ready, but is functional. Some functions are not yet ready.

Bugs

Important

If you are not on Windows, or get an error related to the DIRECTORY, you might need to redirect the DIRECTORY. In __main__.py go to the constants section and change the first part of DIRECTORY.

Important

If you get an error related to tables in sqlite3, go to ✨, and then 📂. Then close the app. After which you may delete the database called 2048.db. This will erase all old data, but will fix the bug. This ussually happens due to version change.

Tip

If you find a bug, you may create an issue.

Not Ready Features

Help ❔

The help button [❔], is not ready. It should show How To Play instructions.

Undo 🔙

The undo button [🔙], is not ready. It will go back one move.

Hint 💡

The hint button [💡], is not ready. It will show a suggested move.

Settings ⚙️

The settings button [⚙️], is not ready. It will show a settings page.

Open Folder 📂

The open folder [📂], is not ready for non-windows. It opens the data folder in file explorer.

Slide Animation

The sliding animation, is not ready.

The original 2048 was made by Gabriele Cirulli in JavaScript and CSS. If you want to play the actual game: play2048.co.

I am attempting to make the same game in Python.

How To Play

If you have never played 2048 before here is the rules of 2048:

You start with either pressing space bar or the PLAY button.

You have a 4x4 grid, in which there 2 blocks in the start, you have 90% chance of haing an 2, while 10% chance of having an 4 in the start.

You can either play UP, DOWN, LEFT, or RIGHT. Each of them will result all the blocks sliding in that direction. And the blocks having the same numbers will merge, making a block that is the sum of the merged blocks.

You win when you reach 2048.

The game ends when you have no empty spaces left and also no moves left.

You may even press the END button, or esc to clear the game, and save your score.

Installation

Source Code (recommended)

This requires Python 3.10+, atleast that's what I think.

This also requires all the needed modules, for which you need to do

pip install -r requirements.txt

This will install all needed modules and libraries, see required modules for more information.

Tip

You might even edit some things in the code to change the working flow of the code. Like the directory where the database is saved, or the color of the background, etc.

Warning

Some things may break when tampered with. Please edit the code with caution.

Executable (not ready)

On Windows you can install the executable from releases. The executable is only compatible with Windows currently.

Caution

It is quite slow because it is made with PyInstaller. If you have any suggestions, put them in this discussion.

Data Stored

Your score is locally saved along with the time and the highest number you reached. You may even enter your name, which is optional.

Note

No other information is used, stored, or sent to us.

Requirements

Font

The font used is from JetBrainsMono. I have peronally used JetBrains Mono Medium, which is available in the repository. You can change the font in the constants section.

Modules

customtkinter - pip install customtkinter

pillow (PIL) - pip install pillow

CTkTable - pip install CTkTable

Only For Windows:

pywinstyles - pip install pywinstyles

Only for non-Windows:

comment-out pywinstyles in requirements.txt,

Note

This will result in opaque and broken, winning and losing screen. If you have any suggestion to fix this on non-Windows computers, please suggest in this discussion.

Rate

How would you rate this game? Rate Here

Commit History

The commit activity is linked here.

The commit history is linked here.

License

This project has the MIT License,

MIT License

Copyright (c) 2024 Aahan Salecha

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

as LICENSE