Metadata-Version: 2.1
Name: pyxel-lander
Version: 1.4.0
Summary: Lunar Lander game tribute written in Python with Pyxel retro game engine
Home-page: https://github.com/humrochagf/pyxel-lander
License: MIT
Author: Humberto Rocha
Author-email: humrochagf@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Environment :: X11 Applications
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Desktop Environment
Classifier: Topic :: Games/Entertainment :: Arcade
Classifier: Topic :: Games/Entertainment :: Simulation
Requires-Dist: pyxel (>=1.5.5,<2.0.0)
Project-URL: Repository, https://github.com/humrochagf/pyxel-lander
Description-Content-Type: text/markdown

# Pyxel Lander

[![PyPI](https://img.shields.io/pypi/v/pyxel-lander.svg)](https://pypi.org/project/pyxel-lander/)
[![PyPI - License](https://img.shields.io/pypi/l/pyxel-lander.svg)](https://pypi.org/project/pyxel-lander/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyxel-lander.svg)](https://pypi.org/project/pyxel-lander/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

Lunar Lander game tribute written in Python with [Pyxel](https://github.com/kitao/pyxel) retro game engine.

![screenshot](https://raw.githubusercontent.com/humrochagf/pyxel-lander/master/images/screenshot.png)

## Features

- Procedural map generation
- Pixel perfect collision detection
- Fuel propulsion system
- HUD with the Lunar Module feedback
- Landing impact detection

## Controls

- Use the `arrow` keys to control the Lunar Module.
- The `s` key starts the game.
- You can change maps with the `m` key on the menu.
- The `r` key restarts the game.
- You can exit the game with the `q` or `esc` keys.

## Packaged executable

If you want to play the game without installing the development tools you can check it on [itch.io](https://humrochagf.itch.io/pyxel-lander).

## PyPI Installation

This game runs with Python 3.7 or above.

You can use [pipx](https://pipxproject.github.io/pipx/) to install the game and have it available as an standalone program:

```shell
pipx install pyxel-lander
```

Then you can run the game running:

```shell
pyxel-lander
```

**Warning:** The Pyxel requirement uses external libraries, make sure you have them all installed by looking into its [docs](https://github.com/kitao/pyxel#how-to-install).

## Running from source code

To run it from the source code you need first to clone from the repository:

```shell
git clone https://github.com/humrochagf/pyxel-lander.git
```

After cloned, access the folder and install its dependencies with [poetry](https://python-poetry.org/):

```shell
cd pyxel-lander/
poetry install
```

With everything installed run the game with:

```shell
poetry run python -m pyxel_lander
```

