https://github.com/darkempire78/readme-2048

To play the famous 2048 game on a README file. The game is played directly on a GitHub repo. Everyone can play a move.
https://github.com/darkempire78/readme-2048

2048 2048-game 2048game readme readme-template

Last synced: about 1 month ago
JSON representation

To play the famous 2048 game on a README file. The game is played directly on a GitHub repo. Everyone can play a move.

• Host: GitHub
• URL: https://github.com/darkempire78/readme-2048
• Owner: Darkempire78
• License: gpl-3.0
• Created: 2021-03-23T17:30:25.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-14T21:10:12.000Z (over 3 years ago)
• Last Synced: 2024-05-02T02:27:10.109Z (8 months ago)
• Topics: 2048, 2048-game, 2048game, readme, readme-template
• Language: Python
• Homepage: https://github.com/Darkempire78/Darkempire78
• Size: 4.26 MB
• Stars: 13
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
 

#  Readme 2048

This template repository contains the source code for a Python 2048 automatic bot, together with GitHub Workflows in order to allow ANYONE to play 2048 from a README file. Want to see this in action? Go to my profile page and feel free to try it out by yourself!



## Steps to make your own repo

1. Click on `"Use this template"`.

2. Replace the the link (`https://github.com/Darkempire78/Readme-2048`) to the link of your own repository in each files.

3. Rename the folder `.github/_workflows` to `.github/workflows`.

4. Delete this README file and make your own `README.md` based on the `README.template.md`. Do not forget that the both comments `"<-- 2048GameActions -->"` and `"<-- 2048Ranking -->"` cannot be deleted!

## Themes

You can change the theme of the gameboard between dark and light mode editing `config.json`.

## Features

* Play to 2048

* Archive games

* Leaderboard

* Dark mode

## Archives

The current game is always called `Data/Games/current.json`. All games are automatically archived into the `Data/Games/` folder.

## To do

- [ ] Remove impossible actions

- [ ] Do not download Pillow each time 

- [ ] Prevent from runing twice actions at the same time (https://github.com/marketplace/actions/wait-for-check)

## Discord

Join the Discord server !

[![](https://i.imgur.com/UfyvtOL.png)](https://discord.gg/sPvJmY7mcV)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

This project is under [GPLv3](LICENSE).