Home
Alien Invasion A Modern Space Invaders
Welcome to the official documentation for Alien Invasion. This classic
arcade-style game blends Space Invaders gameplay with modern engineering
practices: strict type safety, comprehensive testing, and a clean, modular
architecture.
โจ Features¶
- ๐ฏ Classic Arcade Gameplay - Fast-paced alien shooting action
- ๐จ Modern Graphics - Crisp sprites and smooth animations
- ๐ต Dynamic Audio - Immersive sound effects and background music
- ๐ High Score System - Encrypted score persistence
- ๐ Multi-language Support - Localized UI strings
- โ๏ธ Configurable Settings - Customizable game parameters
- ๐งช Type-Safe Codebase - Full mypy strict mode compliance
- ๐ฆ Cross-Platform Builds - Windows (.exe) and macOS (.dmg) support
๐ Documentation Overview¶
๐ Getting Started¶
New to Alien Invasion? Start here to get up and running quickly.
- Quick Start - Get the game running in 5 minutes
- Installation - Detailed setup instructions
- Configuration - Customize your game experience
๐ฎ Gameplay Guide¶
Master the game mechanics and improve your high score.
- Gameplay Basics - Core mechanics and objectives
- Controls - Keyboard shortcuts and commands
- Game Modes - Different ways to play
- Scoring System - How points are calculated
- Power-ups - Special abilities and bonuses
๐ ๏ธ Developer Guide¶
Build, extend, and customize the game with confidence.
- Core Concepts - Fundamental design patterns
- Game Architecture - System design overview
- Entity System - Sprite-based entity management
- Audio System - Sound and music integration
- Asset Management - Loading and bundling resources
- Code Quality - Standards and best practices
- Performance Optimization - Profiling and tuning
๐งช Testing & Quality Assurance¶
Ensure reliability with comprehensive testing strategies.
- Testing Guide - Unit, integration, and headless testing
- Type Safety - mypy strict mode compliance
- CI/CD Pipeline - Automated quality checks
๐ค Contributing¶
Join the community and help improve Alien Invasion!
- Contributing Guide - How to contribute code
- Code of Conduct - Community standards
- Development Workflow - Branch strategy and PR process
- Release Process - Version management
๐ฏ Quick Start¶
# Clone the repository
git clone https://github.com/avilesxd/code-destroy-aliens.git
cd code-destroy-aliens
# Install dependencies
npm install
# Run the game
npm run dev
That's it! The game will launch immediately. See the Quick Start Guide for more details.
๐ Resources¶
- ๐ฆ GitHub Repository - Source code and releases
- ๐ Issue Tracker - Report bugs or request features
- ๐ Pull Requests - Contribute to the project
- ๐ Documentation Site - Project docs and guides
- ๐ฌ Discussions - Ask questions and share ideas
๐๏ธ Built With¶
- Python 3.8+ - Core programming language
- Pygame 2.5.0+ - Game development framework
- pytest - Testing framework
- mypy - Static type checker
- black - Code formatter
- PyInstaller - Windows executable bundler
- py2app - macOS application bundler
๐ License¶
This project is licensed under the MIT License - see the LICENSE file for details.
Made with โค๏ธ by the Alien Invasion Team
โญ Star us on GitHub if you find this project helpful!