/pygame-template

PyGame template and baseline directory structure to simplify project setup.

Primary LanguagePython

Name: main_template.py

Description: This is a pygame basic template/dir structure that does nothing more than help w/ preliminary repetitve setup steps for the series of games I'm writing this year. Update class GameObj name and __main__ class calls to get started. Also includes pyganim import for easy sprite animation. I may refine further as I get through the games this year - or, more likely, I may not haha...

Look in main_template.py for # TODO: items that need to be reviewed. Feel free to refine 'til your heart's content.

Date: 7-Jan-2023

Author: jelmore

Usage (for Linux/MacOS X):

  1. Clone repository: https://github.com/jerryrelmore/pygame-template.git
  2. Rename the directory as desired: mv pygame-template MY_AWESOME_PYGAME
  3. cd MY_AWESOME_PYGAME
  4. Setup a virtual environment or install requirements as system packages: pip3 install -r requirements.txt
  5. Rename the template: mv src/main_template.py src/MY_AWESOME_GAME.py
  6. ...
  7. Profit!