Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/francis-clairicia/pydiamond

PyDiamond engine is a game engine for Python game developers.
https://github.com/francis-clairicia/pydiamond

game game-development game-engine game-engine-2d pygame pygame-library python python3

Last synced: 8 days ago
JSON representation

PyDiamond engine is a game engine for Python game developers.

Host: GitHub
URL: https://github.com/francis-clairicia/pydiamond
Owner: francis-clairicia
License: gpl-3.0
Created: 2021-07-18T22:00:21.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-04-29T21:04:09.000Z (8 months ago)
Last Synced: 2024-04-29T23:01:08.384Z (8 months ago)
Topics: game, game-development, game-engine, game-engine-2d, pygame, pygame-library, python, python3
Language: Python
Homepage:
Size: 46.1 MB
Stars: 12
Watchers: 2
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # PyDiamond

[![Build](https://github.com/francis-clairicia/PyDiamond/actions/workflows/build.yml/badge.svg)](https://github.com/francis-clairicia/PyDiamond/actions/workflows/build.yml)

[![Test](https://github.com/francis-clairicia/PyDiamond/actions/workflows/test.yml/badge.svg)](https://github.com/francis-clairicia/PyDiamond/actions/workflows/test.yml)

[![Lint](https://github.com/francis-clairicia/PyDiamond/actions/workflows/lint.yml/badge.svg)](https://github.com/francis-clairicia/PyDiamond/actions/workflows/lint.yml)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/francis-clairicia/PyDiamond/main.svg)](https://results.pre-commit.ci/latest/github/francis-clairicia/PyDiamond/main)

[![PyPI](https://img.shields.io/pypi/v/pydiamond-engine)](https://pypi.org/project/pydiamond-engine/)

[![PyPI - License](https://img.shields.io/pypi/l/pydiamond-engine)](https://github.com/francis-clairicia/PyDiamond/blob/main/LICENSE)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydiamond-engine)

[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

PyDiamond engine is a game engine for Python game developers.

The framework uses the popular [pygame library](https://github.com/pygame/pygame/).

## Installation

The installation can be done using `pip`:

```

pip install pydiamond-engine

```

## Usage

Example with the minimal requirements:

```py

from pydiamond.window.display import Window

def main() -> int:

    w: Window = Window(title="my window", size=(800, 600))

    with w.open():

        while w.loop():

            for event in w.process_events():

                # do some stuff

                pass

            w.clear()

            # draw your objects

            w.refresh()

    return 0

if __name__ == "__main__":

    exit(main())

```

This code will open a small window.

### Documentation

Coming soon. :)

## Development

### Dependencies

PyDiamond is developed based on pygame and Python (obviously). In addition, some features of pygame are available with a specific version of the SDL.

Dependency version:

- CPython >= 3.10

- pygame == 2.1.2

- SDL >= 2.0.16 (vendored in pygame)

- SDL_image >= 2.0.0 (vendored in pygame)

- SDL_mixer >= 2.0.0 (vendored in pygame)

- Other python dependencies referred by `pyproject.toml`

### Setup

Use the following command to install all the necessary dependencies

```sh

python -m devtools repo

```

## Credits

### Vendored-in packages

- [Gradient](https://www.pygame.org/project-gradients-307-.html) module by DR0ID

- [OrderedSet](https://github.com/rspeer/ordered-set) collection by rspeer

## License

This project is licensed under the terms of the [GNU General Public License v3.0](https://github.com/francis-clairicia/PyDiamond/blob/main/LICENSE).