starcrusher2025-games 0.2.2

A game engine.

# 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

# 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.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

Adding Game Objects

You can add additional game objects to your game by creating instances of GameObject and adding them to the game:

from starcrusher2025_games.configs.GameObject import GameObject

obj1 = GameObject(start_pos=(100, 100), size=(50, 50), speed=3, color=(255, 0, 0))
obj2 = GameObject(start_pos=(200, 200), size=(75, 75), speed=2, color=(0, 255, 0))

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

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.