# PyScenes

**Repository Path**: majun_obm/PyScenes

## Basic Information

- **Project Name**: PyScenes
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-27
- **Last Updated**: 2025-11-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PyScenes

![GitHub](https://img.shields.io/github/license/treygilliland/PyScenes)
![Travis (.org)](https://img.shields.io/travis/treygilliland/pyscenes)
[![Documentation Status](https://readthedocs.org/projects/pyscenes/badge/?version=latest)](https://pyscenes.readthedocs.io/?badge=latest)
![Lines of code](https://img.shields.io/tokei/lines/github/treygilliland/pyscenes)
![Codecov](https://img.shields.io/codecov/c/gh/treygilliland/pyscenes?color=pink)

PyScenes is [PyGame 2](https://www.pygame.org/wiki/about) library designed to provide the high-level functionality used in games and multi-media programs so that users can focus on creating rather than debugging. PyScenes aims to provide classes and functions related to sprites, backgrounds, sounds, images, text, and more!

## Usage

PyScenes is designed to be used as an all-in-one project template and interface over the PyGame engine.

The PyScenes package contains two key components:

1. PyScenes module containing everything needed to create a game
2. BaseScene class used to define a template for creating scenes for your game

To make a game with pyscenes, create a copy of the game_template.py file and start creating your scenes there!

To see an example of using PyScenes, navigate to the pyscenes/examples directory
and run any of the self-contained examples there. More coming soon!

An example implementation of the BaseScene class:

![Example](https://github.com/treygilliland/PyScenes/blob/master/pyscenes/examples/assets/example_scene.png)

## Installation

PyScenes can be installed through PyPi using the following command:

```
pip install pyscenes
```

## Documentation

Documentation is hosted through ReadTheDocs [here](https://pyscenes.readthedocs.io/).

Created using Sphinx.

## Contributing

Coming Soon.

See CONTRIBUTING.md for more.

## License

Distributed under the GPLv3 license. See LICENSE.md for more.

## Acknowledgements

PyScenes is heavily inspired by and contains code from
[Pygame_functions](https://github.com/StevePaget/Pygame_Functions) by Steve Paget.
This library was very useful when I first started learning to make games with Python and
its simplicity and ease of use is a great motivation for the project.

The design for the scene-based OOP implementation comes from the Nerd Paradise blog pygame tutorial.
See more [here](https://nerdparadise.com/programming/pygame/part7).