# 🚀 Treasure Island

A beginner-friendly Python "Choose Your Own Adventure" text game where your choices decide whether you find the treasure.

## 📚 Table of Contents

- [Overview](#-overview)
- [Requirements](#-requirements)
- [Setup](#-setup)
- [Run](#-run)
- [Tests](#-tests)
- [License](#-license)
- [Links](#-links)

## 🧭 Overview

You start at a crossroad and pick your way through the story using `if` / `elif` / `else` logic. Answers are lowercased and trimmed, so `Left` and ` LEFT ` work too, and invalid answers are asked again.

```text
crossroad: left or right
  right -> Game Over (hole)
  left  -> lake: wait or swim
            swim -> Game Over (trout)
            wait -> island: red, yellow or blue door
                      red    -> Game Over (fire)
                      blue   -> Game Over (beasts)
                      yellow -> You Win!
```

Only one path wins. Feel free to rewrite the story in `src/treasure_island/game.py`. It is part of Udemy's *100 Days of Code: The Complete Python Pro Bootcamp* and has no runtime dependencies.

## 📋 Requirements

- Python 3.13 or newer
- `pytest` (only for running the tests)

## 🛠️ Setup

Create and activate a local virtual environment in the project root:

```bash
python -m venv .venv
```

Activate it:

- Windows (PowerShell): `.venv\Scripts\Activate.ps1`
- Windows (cmd): `.venv\Scripts\activate.bat`
- Git Bash on Windows: `source .venv/Scripts/activate`
- macOS / Linux: `source .venv/bin/activate`

Install the project with the test tools:

```bash
pip install -e ".[dev]"
```

Leave the environment with `deactivate`.

Optional: copy `.env.example` to `.env` and fill in `GIT_TOKEN`. It is only used for repository maintenance (such as setting the repository description and topics), never to run the game. `.env` is git-ignored.

## ▶️ Run

```bash
python -m treasure_island
```

or, after installing:

```bash
treasure-island
```

## 🧪 Tests

```bash
pytest
```

## 📄 License

Released under the [GNU Affero General Public License v3.0](LICENSE) (AGPL-3.0-or-later).

## 🔗 Links

- [Repository](https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code)
- [Documentation](https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/003-treasure_island#readme)
- [Issue tracker](https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/003-treasure_island/issues)