planetoids-game 0.7.2
A retro-style space shooter game built with Pygame.
Requires Python: >=3.7

# **Planetoids**: A Retro-Inspired Space Shooter

<p align="center">
  <img src="media/planetoids.gif" alt="GIF of Planetoids gameplay showing asteroids, a spaceship, and CRT visual effects">
</p>

## **What is it?**
**Planetoids** is a fast-paced, retro-inspired **arcade space shooter** built in Python with **Pygame**.  
Dodge asteroids and experience a vintage arcade feel with CRT effects, glitch animations, and pixel-perfect scaling.

[![Issues](https://img.shields.io/github/issues/chris-greening/planetoids)](https://github.com/chris-greening/planetoids/issues)
[![License](https://img.shields.io/github/license/chris-greening/planetoids)](LICENSE)
[![PyPI Downloads](https://static.pepy.tech/badge/planetoids-game)](https://pepy.tech/projects/planetoids-game)

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/chrisgreening)


---

## **🪐 Key Features**
- **Fast-paced asteroid destruction**
- **Smooth FPS-independent physics**
- **Retro CRT visual effects & glitch animations**
- **Classic arcade gameplay mechanics**
- **Power-ups and increasing difficulty**
- **Pixel-perfect scaling for all screen sizes**

<p align="center">
  <img src="media/crt_effect.gif" alt="CRT visual effect applied to gameplay">
</p>

---

## **💾 Installation**

### **🔹 Install from PyPI (Recommended)**
The easiest way to install **Planetoids** is through **pip**:
```sh
pip install planetoids-game
```
Once installed, launch the game by running:
```sh
planetoids
```

### **🔹 Install from Source**
If you want the latest development version, you can install directly from GitHub:
```sh
git clone https://github.com/chris-greening/planetoids-game.git
cd planetoids-game
pip install -e .
```
Then, start the game with:
```sh
planetoids
```
---

## **🚀 Running the Game**
Once installed, you can start **Planetoids** in one of the following ways:

### **🔹 Run from Source**
If you cloned the repository, navigate to the project folder and run:
```sh
python3 -m planetoids
```
This ensures that Python finds the package correctly.

### **🔹 Run as an Installed Package**
If you installed **Planetoids** via **pip**, simply run:
```sh
planetoids
```
This will launch the game without needing to reference the Python interpreter directly.

---

## **🎮 Controls**
| Key          | Action                          |
|-------------|--------------------------------|
| **Arrow Keys** | Rotate & Thrust |
| **Space** | Fire |
| **P** | Pause |
| **Enter** | Select Menu Items |

---

## **🔧 Configuration & Settings**
You can **modify settings** via the **Options Menu**:


### **Available Settings**
| Setting          | Description                              |
|-----------------|----------------------------------------|
| **crt_enabled** | Enable CRT retro effect |
| **glitch_intensity** | "minimum", "medium", or "maximum" |
| **pixelation** | "minimum", "medium", or "maximum" |

---

## **👨‍💻 Contributing**
All contributions, bug reports, and suggestions are **welcome**!  
- **[Open an Issue](https://github.com/chris-greening/planetoids/issues/new/choose)**  
- **[Start a Discussion](https://github.com/chris-greening/planetoids/discussions)**  
- **Pull Requests** are always appreciated!

---

## **📜 License**
This project operates under the **MIT** license. See [LICENSE](LICENSE) for details.

---

## **📩 Support**
Feel free to **reach out** if you have any questions or feedback!
* **Email:**  
  * chris@christophergreening.com
* **Twitter:**  
  * [@ChrisGreening](https://twitter.com/ChrisGreening)
* **LinkedIn**  
  * [Chris Greening](https://www.linkedin.com/in/chris-greening-646411139/)
* **Personal Website**  
  * [www.christophergreening.com](https://www.christophergreening.com/contact)