Metadata-Version: 2.4
Name: breachpy
Version: 1.0.2
Summary: Cyberpunk 2077 Breach Protocol minigame in your terminal
Author-email: Yaroslav Akamirsky <akamirsky.yaros@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Topic :: Games/Entertainment :: Puzzle Games
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# breachpy
### Famous "Breach protocol" puzzle game from "Cyberpunk 2077" in your terminal

![Version](https://img.shields.io/badge/version-1.0.2-red) ![License](https://img.shields.io/badge/license-GPL3-cyan)

![Logo](img/logo.svg)

## UI

- Fancy TUI with 'cyberpunk-style' color scheme

![Maingame](img/screenshots/Maingame.png)

- 3 Difficulty levels

![Difficulties](img/screenshots/Difficulties.png)

- Easy controls by arrows or Vim navigation keys (H J K L)

![Defeat](img/screenshots/Defeat.png)

## Installation

### Via pip/pipx

1. Make sure you have [python](https://www.python.org/downloads/) installed in your system

2. 
   - **Windows (cmd|powershell):**

    ```shell
    pip install breachpy
    ```
   - **Linux|macOS|FreeBSD|OpenBSD (bash|zsh|fish or any):** (Make sure you have [pipx](https://pipx.pypa.io/stable/how-to/install-pipx/) installed)
    ```bash
    pipx install breachpy
    ```
3. Run the game and have fun!
```shell
breachpy
```

### Manual execution (from source)

1. Clone the repository: **Be sure you have installed [python](https://www.python.org/downloads/) and [git](https://git-scm.com/install/linux)**
```shell
git clone https://codeberg.org/Y-Akamirsky/breachpy
```
2. Then change directory to the project folder
```shell
cd breachpy
```
3. Run the game as module using Python's module flag:
```shell
python -m src.breachpy.main
```
4. Have Fun!

## Contributing
- Contributions are welcome! Feel free to open Issues or submit Pull Requests. I'll highly appreciate it!

## Built With
- Python
- Some vibecode
- Some interest
- For fun
