https://github.com/vbetsch/undercover
🔎 Undercover game adapted in Python CLI
https://github.com/vbetsch/undercover
python
Last synced: about 1 year ago
JSON representation
🔎 Undercover game adapted in Python CLI
- Host: GitHub
- URL: https://github.com/vbetsch/undercover
- Owner: vbetsch
- Created: 2023-01-23T14:46:56.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-04T14:13:21.000Z (over 1 year ago)
- Last Synced: 2025-03-26T18:52:39.987Z (over 1 year ago)
- Topics: python
- Language: Python
- Homepage:
- Size: 73.2 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Undercover
🔎 Python CLI adapted from the [undercover](https://play.google.com/store/apps/details?id=com.yanstarstudio.joss.undercover&gl=US) game
```
├── app
│  ├── config.json
│  ├── data
│  │  ├── default.json
│  │  ├── games.json
│  │  ├── rules.json
│  │  └── words.json
│  ├── lang
│  │  ├── en.json
│  │  └── fr.json
│  ├── main.py
│  └── src
│  ├── components
│  │  ├── Menu.py
│  └── core
│  ├── Game.py
│  ├── Inspector.py
│  ├── Interactor.py
│  ├── Meta.py
│  ├── Service.py
│  └── Utils.py
├── Makefile
├── README.md
├── requirements.txt
├── scripts
│  ├── _constants.py
│  ├── _core.py
│  ├── make.py
│  ├── build.py
├── tests
│  ├── _menu.py
│  └── test_auto.py
└── venv
```
## Dependencies
- [python 3.10](https://docs.python.org/3.10/)
### Windows
Download and install it from [python.org](https://www.python.org/downloads/macos/) or run on terminal
```powershell
$ winget install -e --id Python.Python -v 3.10
```
### MacOS
Download and install it from [python.org](https://www.python.org/downloads/macos/) or run on terminal
```bash
$ brew install python
```
## Installation
### Windows
- Create virtual environment from this directory
```powershell
$ python -m venv venv
```
- Install python requirements from this directory
```powershell
$ pip install -r requirements.txt
```
- Generate development data
```powershell
$ python scripts/make.py
```
- Compile requirements
```powershell
$ pip freeze > requirements.txt
```
- Build your version
```powershell
$ python scripts/build.py -l [lang]
```
### Linux & MacOS
- Prepare environment
```bash
$ make init
```
- Compile environment
```bash
$ make env
```
- Build version
```bash
$ make build
```