Skip to main content

A modular pygame_core library for Pygame-based 2D games.

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Pygame Core

Overview

Pygame Core is a modular and reusable library designed to simplify the development of 2D games using the Pygame library. It provides essential components for managing game loops, scenes, input handling, and utility functions, allowing developers to focus on building their game's unique features.

Features

  • Game Loop Management: Simplifies the main game loop with FPS control.
  • Scene Management: Enables seamless transitions between game scenes (e.g., menus, gameplay).
  • Input Handling: Centralized input management for keyboards or other devices.
  • Utilities: Provides tools like collision detection and default settings.
  • Extensibility: Designed for easy customization and expansion.

Installation

Install the package using pip:

pip install pygame-pygame_core

Usage

Setting Up Your Game

Below is an example of how to use Pygame Core to create a simple game:

import pygame
from pygame_core import Game, Scene, SceneManager


class MainMenu(Scene):
    def update(self, input_manager):
        if input_manager.is_pressed(pygame.K_RETURN):
            return Gameplay(self.screen)

    def render(self):
        self.screen.fill((0, 0, 0))
        font = pygame.font.Font(None, 74)
        text = font.render("Press Enter to Start", True, (255, 255, 255))
        self.screen.blit(text, (150, 300))


class Gameplay(Scene):
    def update(self, input_manager):
        # Game logic goes here
        pass

    def render(self):
        self.screen.fill((30, 30, 30))


if __name__ == "__main__":
    pygame.init()
    screen = pygame.display.set_mode((800, 600))
    pygame.display.set_caption("Pygame Core Example")

    manager = SceneManager(MainMenu(screen))
    game = Game(screen)
    game.run(manager)
    pygame.quit()

Key Components

  • Game: Manages the main game loop and FPS control.
  • Scene: A base class for creating game scenes with update and render methods.
  • SceneManager: Handles scene transitions.
  • InputManager: Provides a clean interface for checking key states.
  • Utils: Includes common utilities like collision detection.

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Run a pylint pylint core
  5. Submit a pull request.

Please ensure all tests pass before submitting your PR.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Upload

Remember to update version number in VERSION file and delete the dist folder before uploading.

Build:

python -m build

Upload:

python -m twine upload dist/*

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

pygame_pygame_core-0.1.33.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygame_pygame_core-0.1.33-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file pygame_pygame_core-0.1.33.tar.gz.

File metadata

  • Download URL: pygame_pygame_core-0.1.33.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for pygame_pygame_core-0.1.33.tar.gz
Algorithm Hash digest
SHA256 2b33f6dee420f098b345dd449fcd35a5a0206778de3f41c9c336dbb4b6cca605
MD5 f3b072fe627328afd28eb290f169b879
BLAKE2b-256 085ea990ee0e3a1d2757a090db464b88337d580aa78830db2e65bdb955809eee

See more details on using hashes here.

File details

Details for the file pygame_pygame_core-0.1.33-py3-none-any.whl.

File metadata

File hashes

Hashes for pygame_pygame_core-0.1.33-py3-none-any.whl
Algorithm Hash digest
SHA256 8f823c1c0a533ed82ddad7fcec5297fdbc38b812084b8da66d96ee8e3127b166
MD5 dfea7f012828c76de74bc67278988b05
BLAKE2b-256 a7faf0d4e52fc49ffd5e79174e2508da70973a4a20faa1de594db446b37a128e

See more details on using hashes here.

Supported by

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