/hackShip-project

Primary LanguagePythonMIT LicenseMIT

Hack It Ship It

Contribution

Requirements

Developers need Python 3 installed on their local machine.

Setup

  1. Clone this repository
  2. Create a virtual environment in project directory. 
    python -m venv venv
  3. Activate the virtual environment. 
    # Windows
venv/Scripts/activate

# MacOS / Linux
source venv/bin/activate
  4. Install dependencies. 
    pip install -r requirements.txt

How to Run

To start the game, use the following command.

python src/main.py

Make sure you have up-to-date dependencies.

Project Structure

  • README.md : This document.
  • requirements.txt : List of dependencies of this project.
  • src : Source code directory.
    • main.py : Entrypoint of the game.
    • config.py : Configuration module.
    • Scene.py : Scene is a class responsible for event handling & rendering.
    • StartScene.py : Start menu scene.
    • MainScene.py : Gameplay scene.
    • assets : Directory for binary asset files.
      • fonts
      • images

Packaging

Run the following command to package the game.

pyinstaller --onefile -w --add-data "src/assets/;." src/main.py