Metadata-Version: 2.4
Name: chrome-dino-runner
Version: 0.1.0
Summary: A Python and Pygame recreation of the Chrome dinosaur runner game.
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: pygame-ce<3,>=2.5
Requires-Dist: platformdirs<5,>=4

<div align="center">

# Chrome Dino Runner

**A Python and Pygame take on Chrome's classic offline dinosaur game.**

[![Python](https://img.shields.io/badge/Python-3.8%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/)
[![Pygame CE](https://img.shields.io/badge/Pygame%20CE-powered-00A86B)](https://pyga.me/)
[![uv](https://img.shields.io/badge/package%20manager-uv-DE5FE9)](https://docs.astral.sh/uv/)

<img src="src/chrome_dino_runner/assets/Other/Chrome%20Dino.gif" alt="Chrome Dino Runner gameplay: the dinosaur runs, jumps over obstacles, and the start screen is shown" width="800">

[Watch the MP4 recording](src/chrome_dino_runner/assets/Other/Chrome%20Dino.mp4)

</div>

## About

This project recreates the familiar endless runner as a small desktop game.
Jump over cacti, duck under flying obstacles, and see how high you can score.

## Get started

You’ll need [Python 3.8 or newer](https://www.python.org/) and
[uv](https://docs.astral.sh/uv/getting-started/installation/).

```console
git clone https://github.com/dhhruv/Chrome-Dino-Runner.git
cd Chrome-Dino-Runner
uv sync
uv run chrome-dino-runner
```

Alternatively, start the game as a Python module:

```console
uv run python -m chrome_dino_runner
```

## Controls

| Key | Action |
| --- | --- |
| Any key | Start or restart |
| Up arrow or Space | Jump |
| Down arrow | Duck |
| P | Pause |
| U | Resume |

Your high score is saved in your operating system's per-user application data
directory, not in the project folder. Existing `score.txt` scores in the
launch directory are migrated there the next time you start the game.

- **Windows:** `%LOCALAPPDATA%\Chrome Dino Runner\score.txt`
- **macOS:** `~/Library/Application Support/Chrome Dino Runner/score.txt`
- **Linux:** `$XDG_DATA_HOME/Chrome Dino Runner/score.txt` (usually
  `~/.local/share/Chrome Dino Runner/score.txt`)

## Development

The project uses a `src`-layout package. Install the project and its
dependencies into the uv-managed environment with `uv sync`, then launch it
with `uv run chrome-dino-runner`.

Build a wheel and source distribution with:

```console
uv build
```

```text
src/chrome_dino_runner/
├── __main__.py
├── game.py
└── assets/
```
