Skip to main content

A game engine.

Project description

# Game Engine Package - starcrusher2025

## Introduction
This package provides a simple game engine framework named starcrusher2025. It allows developers to create 2D games using Pygame by providing essential functionalities such as managing the game window, controlling player entities, handling input, and rendering.

## Installation
To install starcrusher2025-games, use pip:

```bash
pip install starcrusher2025-games

Usage

To use starcrusher2025 in your Python projects, follow the examples below:

from starcrusher2025_games import Game

# Initialize the game instance
game = Game()

# Set the background color of the game window
game.window.set_bgc(0, 0, 0)  # Sets the background to black

# Set player attributes
game.player.set_color(255, 0, 0)  # Sets the player color to red
game.player.set_start_pos(400, 300)  # Sets the player starting position
game.player.set_size(50, 50)  # Sets the player size
game.player.set_speed(5)  # Sets the player speed
game.player.load_image("player.png")  # Loads an image for the player
game.set_fps(60) # Sets the fps to 60

# Add game objects
obj1 = game.obj(start_pos=(100, 100), size=(50, 50), speed=0, color=(255, 0, 0))
obj2 = game.obj(start_pos=(200, 200), size=(75, 75), speed=2, color=(0, 255, 0))

game.add_object(obj1)
game.add_object(obj2)

# Set window size
game.window.set_size(800, 600)  # Sets the game window size

# Start the game loop
game.start()

Commands

game.window.set_bgc(r, g, b)

Sets the background color of the game window.

  • Parameters:
    • r: Integer representing the red component of the RGB color (0-255).
    • g: Integer representing the green component of the RGB color (0-255).
    • b: Integer representing the blue component of the RGB color (0-255).

game.player.set_start_pos(start_pos)

Sets the starting position of the player entity.

  • Parameters:
    • start_pos: Tuple representing the (x, y) coordinates of the starting position.

game.player.set_size(size)

Sets the size of the player entity.

  • Parameters:
    • size: Tuple representing the (width, height) of the player entity.

game.player.set_speed(speed)

Sets the speed of the player entity.

  • Parameters:
    • speed: Integer value representing the speed of the player.

game.player.get_player_position()

Returns the player position.

game.player.load_image(image_path)

Loads an image file for the player entity.

  • Parameters:
    • image_path: Path to the image file to be loaded for the player.

game.window.set_size(width, height)

Sets the size of the game window.

  • Parameters:
    • width: Width of the game window in pixels.
    • height: Height of the game window in pixels.

game.set_fps(fps)

Sets the game's target frames per second (FPS).

  • Parameters:
    • fps: Integer value representing the target frames per second.

game.add_object(obj)

Adds a game object to the game.

  • Parameters:
    • obj: Instance of GameObject.

game.start()

Starts the game loop, which handles game logic, rendering, and input handling until the game is stopped or closed.

game.stop()

Stops the game loop and terminates the game.

Additional Features

Collision Handling

Both Player and GameObject have built-in collision handling. When objects collide, their positions are adjusted to avoid overlap.

  • Player.handle_collision(other_object) Handles collision between the player and another game object.

  • GameObject.handle_collision(other_object) Handles collision between two game objects.

License

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


With these changes, you can now create game objects using `game.obj` without needing to import `GameObject` separately. This approach keeps the code cleaner and more intuitive to use.

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

starcrusher2025_games-1.0.2.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

starcrusher2025_games-1.0.2-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file starcrusher2025_games-1.0.2.tar.gz.

File metadata

  • Download URL: starcrusher2025_games-1.0.2.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.0

File hashes

Hashes for starcrusher2025_games-1.0.2.tar.gz
Algorithm Hash digest
SHA256 edd2a8fd266d0c488a70be4ea7e33a2fe2387e2a37ac8d9b6b514e43e900baf3
MD5 e539fffd07afdec0ffdc5334f012d8bc
BLAKE2b-256 8c686a34fe62209a4948d6ec0773569a874c7d5efc0749cd027e1e7601aad86c

See more details on using hashes here.

File details

Details for the file starcrusher2025_games-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for starcrusher2025_games-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 88d052c9e49e9aab15b8925b69022507ed9b92de4844c305d848b7e8b347e159
MD5 5b605dd4aa5f7c1c4ad447c6c6172393
BLAKE2b-256 1dc4f7ce1db2c195fb05607c4615b78ed512db4f30f7e27e25beece406f20a07

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