[idk insert an image of the logo here?]
## 💙 ** Terminal Games ** 💙
#### ConsoleGames
![GitHub Repo stars](https://img.shields.io/github/stars/NoGambling1/ConsoleGames?style=for-the-badge&color=cba6f7) ![GitHub last commit](https://img.shields.io/github/last-commit/NoGambling1/ConsoleGames?style=for-the-badge&color=b4befe) ![GitHub repo size](https://img.shields.io/github/repo-size/NoGambling1/ConsoleGames?style=for-the-badge&color=cba6f7)
![PyPI - Version](https://img.shields.io/pypi/v/gamblingandorangesconsolegames?style=for-the-badge&color=cba6f7)
## Introduction
welcome to the repo ConsoleGames. as the name implies, it is a collection of games that can run in your terminal in python
## Games List
we have a variety of planned and already developed games
- Tic-Tac-Toe
- Tetris
- Sudoku
- Snake
- Chess
- Conway's Game of Life
- Pacman
- Solitare
- More to be added
### other stuff
theres also some other fun things packaged in here
theres a:
- python version of cmatrix written by @shiinadestinee
- asciiquraium thats buggy asf
- sys info viewer
- calc
## Documentation
### Docs info
documentation is still in progress. all of the docs that are currently added are located in the `docs/` directory
## Getting started
wanna play them? pretty simple. you can use the repl link to play them via replit, or you can clone the repo and run `main.py`.
### For Repl:
go [here](https://replit.com/@orangejuiceplz/ConsoleGames)
### For Cloning
open a terminal and go to a directory that you want to house the files in
then,
```bash
git clone https://github.com/NoGambling1/ConsoleGames.git
cd ConsoleGames
```
now, make sure you have the req installed.
```python
pip install -r requirements.txt
```
now you can run,
```bash
cd src
cd gamblingandorangesconsolegames
python main.py
```
### For the lazy people
i've created a couple scripts depending on your os.
navigate to the `auto/` directory and then navigate to your os directory
for example, if you're on windows, you would go to `auto/nt/` directory and download the install.ps1
then, you can simply just run the script. it'll do the work for you lazy people.
lamdashi out ✌️
## LICENSING
ConsoleGames is licensed under the MIT License. See the [LICENSE](https://github.com/NoGambling1/ConsoleGames/blob/main/LICENSE) for more information.
## Contributions
any contributions are welcome, just refer to the [contributor's file](https://github.com/NoGambling1/ConsoleGames/blob/main/docs/CONTRIBUTING.md)
## side notes by lamdashi
this project is on pypi. so you can js import and use in your own project if you want
i just like the little green dot and the fact that i went thru hell for that.
tests are available under the `tests/` directory. more to be added