pyRetroGame 1.1.29

A Python library for creating games in the terminal. test

PyRetroGame ( Beta )

Installation

pip install pyretrogame

---

Getting Started

Create a file and import the library

import pyRetroGame

Declare the game variable

game = pyRetroGame.game.Game(size = Vector2(15, 15))

And start the game

game.start()

Congrats! Now you can initialize the game window.

---

Initialize Player

Create a Player class and extend pyRetroGame.objects.gameEntity

class Player(pyRetroGame.objects.gameEntity):

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def __str__(self):
        # return the Player Texture
        return 'X'

Declare the player variable

# Must return game var to the player
player = Player(position=Vector2(0, 0), game=game)

Spawn the player

game.spawn(player)

Congrats! You've spawned the Player.

---

Player Movements and Keyboard Inputs

To move the Player we use the move function that accepts the direction argument as Vector2(x, y)

player.move(Vector2(1, 0))

In pyRetroGame for getting inputs we use Decorators, Here's an example:

@game.inputHandler('w')
def moveUp():
    player.move(Vector2(0, -1))

You can also use a list of key, but you need to pass a key argument to the function

@game.inputHandler(['w', 's', 'a', 'd'])
def movements(key):
    if key == 'w':
        player.move(Vector2(0, -1))

Here's a total movements function

@game.inputHandler(['w', 's', 'a', 'd'])
def movements(key):
    if key == 'w':
        player.move(Vector2(0, -1))
    if key == 's':
        player.move(Vector2(0, 1))
    if key == 'a':
        player.move(Vector2(-1, 0))
    if key == 'd':
        player.move(Vector2(1, 0))

Congrats! Now you have a Player who moves in the game window.

---

Custom Background

To change the background of the game window you need to use a Background class that return the background texture

class Background():
    def __str__(self):
        # return the Background Texture
        return '0'

And pass the Background class to game

game = pyRetroGame.game.Game(background=Background, size = Vector2(15, 15))

Congrats! You have changed the background of the game window.

---

Game Objects and Collisions

To create a game object you need to create a class and extend pyRetroGame.objects.gameObject

class SolidBlock(pyRetroGame.objects.gameObject):
    def __init__(self, *argvs, **kwargs):
        super().__init__(*argvs, **kwargs)

        # Game Objects has an argument called solid, if you want to make the object solid you need to set it to True
        self.solid = True

    def __str__(self):
        # return the SolidBlock Texture
        return 'B'

Declare the solidBlock variable

wall = SolidBlock(position=Vector2(5, 2), game=game)

And spawn the solid block

game.spawn(wall)

Now, when the player collides with the solidBlock, it will be stopped

If you want to check when the player collides with the solidBlock, you can use the collisionHandler decorator

@player.collisionHandler(wall)
def onCollideWithWall():
    # Do something when the player collides with the wall
    pass

If you want to check when the player collides with the solidBlock, you can use the limitHandler decorator

@player.limitHandler()
def onCollideWithLimit(side):
    # side argument return 'right' - 'left' - 'top' - 'bottom'

    # Do something when the player collides with the limit of the game window
    pass

Congrats! Now you have a solid block that stops the player when it collides with it.

---

Game Process

If you need a loop you can use the @game.process decorator

@game.process()
def process():
    deltaTime = 0.1

    while True:
        
        # Insert your Code Here

        # Very important to declare a delay if you won't the game crash
        time.sleep(deltaTime)

Congrats! Now you have a game loop.

---

Congrats! You've finished the tutorial. You're now ready to start your own game.

Other Functionalities

In the game var you can pass the fixedSize argument to set the window size perfectly match with the game size

game = pyRetroGame.game.Game(background=Background, size = Vector2(15, 15), fixedSIze = True)

In game.start() you can pass the fps argument to set the game FPS

game.start(fps = 60)

And you can also pass a debugging argument to set the debug mode

game.start(fps = 60, debugging = True)

If you need to print some Text you have 2 built-in functions:

game.printText(text = "Hello World", timeout = 2)
game.printAnimatedText(text = "Hello World", animationTimeout = 0.05, timeout = 2)

If you need for some assets you can import the assets package

from pyRetroGame.assets import *

TextAssets.FilledBlock # 'â–ˆ'
TextAssets.BlankSpace # ' '

If need for some calculations you can import the gameMath package

from pyRetroGame.gameMath import *

# Return the distance beetween two Vector2
gameMath.distance(Vector2(0, 0), Vector2(1, 1)) # 1.4142135623730951