Skip to main content

An Event Driven Python Game Engine

Project description

PursuedPyBear

Documentation Status

PursuedPyBear, also known as ppb, exists to be an educational resource. Most obviously used to teach computer science, it can be a useful tool for any topic that a simulation can be helpful.

A Game Engine

At its core, ppb provides a number of features that make it perfect for video games. The GameEngine itself provides a pluggable subsystem architecture where adding new features is as simple as subclassing and extending System. Additionally, it contains a state stack of Scenes simple containers that let you organize game scenes and UI screens in a simple way.

The entire system uses an event system which is as extensible as the rest of the system. Register new values to existing event types, and even overwrite the defaults. Adding a new event type to the system is as simple as firing an instance of your new event class with signal. Instead of a publisher system, the engine knows everything in its own scope and only calls objects with appropriate callbacks. The most basic event is Update and your handlers should match the signature on_update(self, update_event, signal).

Guiding Principles

Because ppb started to be a game framework great for learning with, the project has a few longterm goals:

Education Friendly

Non-technical educators should feel comfortable after very little training. While some programming knowledge is required, the ability to think in objects and responses to events allows educators to only focus on their lessons.

Idiomatic Python

A project built on ppb should look like idiomatic Python. It also should look like modern Python. As such, we often add new language features as soon as they're available, letting a new user always know ppb runs on the latest Python.

Object Oriented and Event Driven

ppb games are built out of instances of objects that inherit from EventMixin. Each object only has enough information to respond to the event provided, which always includes the current BaseScene. Because ppb doesn't have a master list of events, you can provide new ones simply to add more granular control over your game.

Hardware Library Agnostic

Because ppb strongly tries to be extensible and pluggable, each hardware extension can provide its own hooks to ppb, and you can nearly seamlessly switch between various Python libraries.

Fun

One of the maintainers put it best:

If it’s not fun to use, we should redo it

ppb is about filing off the rough edges so that the joy of creation and discovery are both emphasized. A new user should be able to build their first game in a few hours, and continue exploring beyond that.

Try it

Install ppb in the standard method:

pip install ppb

ppb provides a run function that makes it simple to start single screen games.

To make a very simple game, make a directory and add an image file called ship.png to it. Then add the following to a python file and run it.

import ppb


class Ship(ppb.BaseSprite):

    def on_update(self, update_event, signal):
        self.position += 0, -(4 * update_event.time_delta)


def setup(scene):
    scene.add(Ship(pos=(0, 3.5)))


ppb.run(setup=setup)

Compatibility

ppb is guaranteed compatible with Python 3.6 or later.

Get Involved

The fastest way to get involved is to check out the ongoing discussions. If you're already using ppb feel free to report bugs, suggest enhancements, or ask for new features.

If you want to contribute code, definitely read the relavant portions of Contributing.MD

Change Log

0.5.0

We went for a smaller release, but we got a lot done for it only being a few months. The most important bits are that all of the input events are in! Some cool stuff includes sprites scaling automatically and a new way to move between scenes that uses the event system. That means the old method is officially deprecated.

New stuff:

  • MouseButton events
  • Key events
  • Add a title to the game window
  • Sprite scaling based on game unit size
  • Keycodes flags
  • New scene change mechanism that uses the event system

Changed stuff:

  • Scene defaults are now class attributes
  • Most Sprite defaults are now class attributes
  • Flags can now be type hinted properly
  • Scenes no longer infinitely respawn their child scenes if running is True.
  • Fixed an issue with the frame being different dimensions to the viewport.
  • Fixed a bug in the Camera.point_in_viewport function
  • Default pixel ratio is now 64:1 (64 pixels to 1 game unit)
  • New (better) run function
  • Other type hinting fixes

Removed stuff:

  • bb attribute removed from sprites

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ppb-0.7.0.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

ppb-0.7.0-py3-none-any.whl (38.1 kB view details)

Uploaded Python 3

File details

Details for the file ppb-0.7.0.tar.gz.

File metadata

  • Download URL: ppb-0.7.0.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for ppb-0.7.0.tar.gz
Algorithm Hash digest
SHA256 d752719876200e154be0cc7f071e2ad66237e28afbb5ff8c6bb02ec505f47bb4
MD5 7fe9e18fa5e1e5dbbe8addb6a102f1f4
BLAKE2b-256 14c9cadad62d152ee8c4d720b190fc4545dd7d3b171b558c6c7ffb5a3890ee88

See more details on using hashes here.

File details

Details for the file ppb-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: ppb-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 38.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for ppb-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4cfcbc64ba8644d1f8063ff5c46a9f3a5d0d2bce6bb1a3cbb182d891bdad75b5
MD5 f414aa368562a79b3a68294abe80bbc2
BLAKE2b-256 c7c4179a1bc0c1f2461a6e5352ecb238de97817ba46a9e694b33b34f3aab3e7e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page