Code Monkey home page Code Monkey logo

pydiamond's Introduction

PyDiamond

Build Test Lint

pre-commit pre-commit.ci status

PyPI PyPI - License PyPI - Python Version

Checked with mypy Code style: black Imports: isort

PyDiamond engine is a game engine for Python game developers.

The framework uses the popular pygame library.

Installation

The installation can be done using pip:

pip install pydiamond-engine

Usage

Example with the minimal requirements:

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

python -m devtools repo

Credits

Vendored-in packages

License

This project is licensed under the terms of the GNU General Public License v3.0.

pydiamond's People

Contributors

dependabot[bot] avatar francis-clairicia avatar khoality-dev avatar pre-commit-ci[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

khoality-dev

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.