Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 3.47 KB

README.md

File metadata and controls

74 lines (46 loc) · 3.47 KB

MedusaEngine

Medusa is a FOSS Python based game engine for creating 2D games in Python with Pygame. It's not intended to be packaged as a module but is meant to be embedded directly into your project files.

Game demos below

Requirements

Python 3.11 or newer

requirements.txt:

cx_Freeze==7.0.0
cx_Logging==3.2.0
lief==0.14.1
pygame-ce==2.4.1
pygbag==0.9.1  
  • Make sure to double check the individual licenses for each requirement to know what you can and cannot do with them.
  • Cx_freeze, cx_logging, and lief is only required if you use build/buildwindows.py
  • pygbag is only required if you use build/buildweb.py

Project Setup

  • Setup instructions are intended for PyCharm. Setup for other IDEs may vary.
  1. git clone https://github.com/AncientEntity/MedusaEngine.git
  2. Open the project in PyCharm
  3. Configure a new Python Interpreter/Virtual Environment (venv) for the project (Python 3.11>=)
  4. Run pip install -r requirements.txt while in the venv (Inside PyCharm Terminal it should default to the venv automatically)
  5. Done! Try running the run configuration "run game" as there is an example game that should run.

Project Structure

Below is the intended project structure but doesn't necessarily need to be followed.

  • /build: This directory contains build scripts and build outputs for the project. If you need to compile or build the project, you'll find the necessary scripts and configurations here.

  • /engine: This directory contains engine files. These files are responsible for the core functionality of the engine, such as rendering, physics, and audio.

  • /game: This directory contains the game files. Here you'll find the assets, scripts, and other resources that make up the game itself.

Demos & Gifs

Knighty McKnightFace Demo (play here) (source lives in master branch)

python_EA7pzBiGDy

Knighty McKnightFace Demo (play here) (source lives in master branch)

python_BFsRluECuz

Tiny Factory Demo (play here) (source lives in tiny-factory-remake branch)

chrome_qQIUbQQSkM

A* Pathfinding Demo (play here) (source lives in tilemap-pathfinding branch)

python_JWMPJNHslx

Topdown Demo (play here) (source lives in topdown branch)

undefined - Imgur

Topdown Demo (play here) (source lives in topdown branch) python_nd4VQ0PyAy

ThirdParty Demo License Notice

Several Medusa demos contain third party assets with their own separate licenses.

Any assets not listed above are custom, and follow Medusa Engine's MIT License.