Skip to content

🚀 Quick Start Guide

Get Alien Invasion running in just a few minutes.

Prerequisites

  • Python 3.8 or higher
  • Pygame 2.5.0 or higher
  • Node.js (for development tools)
  • Git

Installation

  1. Clone the Repository:
git clone https://github.com/avilesxd/code-destroy-aliens.git
cd code-destroy-aliens
  1. Install Dependencies:
# Install Node.js dependencies
npm install

# Create and activate virtual environment
python -m venv env
env\Scripts\activate  # Windows
source env/bin/activate  # Linux/macOS

# Install Python dependencies (via npm script)
npm run deps:install
  1. Run the Game:
# Development mode
npm run dev

Basic Controls

  • Arrow Keys: Move the ship
  • Spacebar: Shoot
  • P: Pause game
  • Q: Quit game
  • ESC: Return to main menu
  • M: Toggle music
  • S: Toggle sound effects

Development Tools

The project includes several npm scripts for development:

Script Description
npm run dev Run the game in development mode
npm run format Format code using black and isort
npm run format:check Check code formatting
npm run lint Run flake8 linter
npm run typecheck Run mypy type checker
npm run test Run all tests
npm run build:windows Build the Windows executable
npm run build:macos Build the macOS application

Next Steps

Need Help?