Skip to content

pyxora/engine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚙️ pyxora

PyPI - Version Docs CLI License PyPI - Status

pyxora is a lightweight, open-source 2D game engine built on pygame-ce and pymunk.
It’s designed to keep game development simple and flexible.

Perfect for prototypes, game jams, and learning projects.
Handles rendering, physics, scenes and more so you can focus on making your game.

If it looks interesting to you, feel free to give it a try!

Quick Start

Installation

To install, use pip:

pip install pyxora

Create a New Project

To create a new project, you can use the built-in project CLI:

pyxora new project_name

Note: It's recommended to include additional metadata by using extra command-line arguments

Run the project

To run the project you just created:

pyxora run project_name

Command-line interface

As you just can see, the library heavily relies on the built-in CLI to help you manage your projects easily.

To see all available CLI commands:

pyxora --help

Documentation

The documentation is built using pdoc, a docstring generator.
It provides an overview of the engine API and how it works.

It is recommended to read the documentation at least once to understand the engine’s structure and usage.

Documentation: here

Examples

Examples are great for understanding how the engine works and getting familiar with its syntax.

List examples and run one with:

pyxora examples list
pyxora examples run example

Can I Contribute?

Absolutely! Contributions are always welcome. You can:

  • Submit pull requests
  • Open issues
  • Suggest improvements
  • Fix typos or write examples

License

This project is licensed under the MIT License.
See the LICENSE file for the full license text.

About

The core game engine library, built with pygame-ce, pymunk, and more

Topics

Resources

License

Stars

Watchers

Forks

Languages