Merge pull request #143 from realpython/top-python-game-engines

Top-Python-Game-Engines code

Author: acsany

top-python-game-engines/.gitignore

@@ -0,0 +1,8 @@
+.directory
+
+# Ren'Py files
+*.save
+navigation.json
+persistent
+*.rpy?
+*.rpy??

top-python-game-engines/README.md

@@ -0,0 +1,155 @@
+# Top Python Game Engines
+
+This repository contains source code for sample games that you'll see in Real Python's Top Python Game Engines tutorial.
+
+After cloning this repository, you can navigate into each folder to find the source code for the sample games shown in the tutorial. Instructions on how to run each game is shown below.
+
+## Set up the Virtual Environment
+
+It's recommended to use a virtual environment to run these samples. To do so, follow these instructions.
+
+First, create the virtual environment:
+
+```bash
+$ python3 -m venv venv
+```
+
+Next, activate the virtual environment:
+
+```bash
+$ source ./venv/bin/activate
+```
+
+Finally, install the dependencies for these projects:
+
+```bash
+(venv) $ python -m pip install -r requirements.txt
+```
+
+## Pygame
+
+To run the Pygame sample code, first activate the virtual environment:
+
+```bash
+$ source ./venv/bin/activate
+```
+
+Then navigate to the Pygame folder:
+
+```bash
+(venv) $ cd pygame
+```
+
+To run the basic game:
+
+```bash
+(venv) $ python pygame_basic.py
+```
+
+To run the full sample game:
+
+```bash
+(venv) $ python pygame_game.py
+```
+
+## Pygame Zero
+
+To run the Pygame Zero sample code, first activate the virtual environment:
+
+```bash
+$ source ./venv/bin/activate
+```
+
+Then navigate to the Pygame Zero folder:
+
+```bash
+(venv) $ cd pygame_zero
+```
+
+To run the basic game:
+
+```bash
+(venv) $ python pygame_zero_basic.py
+```
+
+To run the full sample game:
+
+```bash
+(venv) $ python pygame_zero_game.py
+```
+
+Alternately, you can use `pgzrun` to run both games:
+
+```bash
+(venv) $ pgzrun pygame_zero_game.py
+```
+
+### Note
+Checkers like [flake8 are unaware](https://pygame-zero.readthedocs.io/en/latest/installation.html#for-flake8-pyflakes) of Pygame Zero's extra built-ins.
+That's why xou'll find `# noqa: F821` inline comments in `pygame_zero_basic.py` and `pygame_zero_game.py`.
+With the `# noqa` inline comments [flake8](https://flake8.pycqa.org/en/3.1.1/user/ignoring-errors.html#in-line-ignoring-errors) ignores the errors that these lines would cause.
+
+## Arcade
+
+To run the Arcade sample code, first activate the virtual environment:
+
+```bash
+$ source ./venv/bin/activate
+```
+
+Then navigate to the Arcade folder:
+
+```bash
+(venv) $ cd arcade
+```
+
+To run the basic game:
+
+```bash
+(venv) $ python arcade_basic.py
+```
+
+To run the full sample game:
+
+```bash
+(venv) $ python arcade_game.py
+```
+
+## adventurelib
+
+To run the adventurelib sample code, first activate the virtual environment:
+
+```bash
+$ source ./venv/bin/activate
+```
+
+Then navigate to the adventurelib folder:
+
+```bash
+(venv) $ cd adventurelib
+```
+
+To run the basic game:
+
+```bash
+(venv) $ python adventurelib_basic.py
+```
+
+To run the full sample game:
+
+```bash
+(venv) $ python adventurelib_game.py
+```
+## Ren'Py
+
+Unlike the other samples, Ren'Py games are developed and run from the Ren'Py Software Development Kit.
+
+Visit the [Ren'Py web page](https://www.renpy.org/) to download the proper SDK for your environment (Windows, macOS, and Linux versions are available).
+
+Then, run the Ren'Py Launcher using the proper command for your environment. Check out the [Ren'Py Quickstart Guide](https://www.renpy.org/doc/html/quickstart.html#the-ren-py-launcher) for the most up-to-date instructions.
+
+To access the basic and full sample games in the Ren'Py launcher, click _Preferences_, then _Projects Directory_. Change the Projects Directory to the `renpy` folder in the repository folder you downloaded. Click _Return_ to return to the main Ren'Py Launcher page.
+
+To run the basic game, click on `basic_game` in the Projects list on the left, then click _Launch Project_.
+To run the full sample game, click on `giant_quest_game` in the Projects list on the left, then click _Launch Project_.
+

top-python-game-engines/adventurelib/adventurelib_basic.py

@@ -0,0 +1,192 @@
+"""
+Basic "Hello, World!" program in adventurelib
+
+This program is designed to demonstrate the basic capabilities
+of adventurelib. It will:
+- Create a simple three-room world
+- Add a single inventory item
+- Require that inventory item to move to the final room
+"""
+
+# Import the library contents
+import adventurelib as adv
+
+# Define your rooms
+bedroom = adv.Room(
+    """
+You are in your bedroom. The bed is unmade, but otherwise
+it's clean. Your dresser is in the corner, and a desk is
+under the window.
+"""
+)
+
+living_room = adv.Room(
+    """
+The living room stands bright and empty. The TV is off,
+and the sun shines brightly through the curtains.
+"""
+)
+
+front_porch = adv.Room(
+    """
+The creaky boards of your front porch welcome you as an
+old friend. Your front door mat reads 'Welcome'.
+"""
+)
+
+# Define the connections between the rooms
+bedroom.south = living_room
+living_room.east = front_porch
+
+# Define a constraint to move from the bedroom to the living room
+# If the door between the living room and front porch door is locked,
+# you can't exit
+living_room.locked = {"east": True}
+
+# None of the other rooms have any locked doors
+bedroom.locked = dict()
+front_porch.locked = dict()
+
+# Set the starting room as the current room
+current_room = bedroom
+
+
+# Define functions to use items
+def unlock_living_room(current_room):
+
+    if current_room == living_room:
+        print("You unlock the door.")
+        current_room.locked["east"] = False
+    else:
+        print("There is nothing to unlock here.")
+
+
+# Create your items
+key = adv.Item("a front door key", "key")
+key.use_item = unlock_living_room
+
+# Create empty Bags for room contents
+bedroom.contents = adv.Bag()
+living_room.contents = adv.Bag()
+front_porch.contents = adv.Bag()
+
+# Put the key in the bedroom
+bedroom.contents.add(key)
+
+# Set up your current empty inventory
+inventory = adv.Bag()
+
+
+# Define your movement commands
+@adv.when("go DIRECTION")
+@adv.when("north", direction="north")
+@adv.when("south", direction="south")
+@adv.when("east", direction="east")
+@adv.when("west", direction="west")
+@adv.when("n", direction="north")
+@adv.when("s", direction="south")
+@adv.when("e", direction="east")
+@adv.when("w", direction="west")
+def go(direction: str):
+    """Processes your moving direction
+
+    Arguments:
+        direction {str} -- which direction does the player want to move
+    """
+
+    # What is your current room?
+    global current_room
+
+    # Is there an exit in that direction?
+    next_room = current_room.exit(direction)
+    if next_room:
+        # Is the door locked?
+        if direction in current_room.locked and current_room.locked[direction]:
+            print(f"You can't go {direction} --- the door is locked.")
+        else:
+            current_room = next_room
+            print(f"You go {direction}.")
+            look()
+
+    # No exit that way
+    else:
+        print(f"You can't go {direction}.")
+
+
+# How do you look at the room?
+@adv.when("look")
+def look():
+    """Looks at the current room"""
+    global current_room
+
+    # Describe the room
+    adv.say(f"{current_room}")
+
+    # List the contents
+    for item in current_room.contents:
+        print(f"There is {item} here.")
+
+    # List the exits
+    print(f"The following exits are present: {current_room.exits()}")
+
+
+# How do you look at items?
+@adv.when("look at ITEM")
+@adv.when("inspect ITEM")
+def look_at(item: str):
+
+    # Check if the item is in your inventory or not
+    obj = inventory.find(item)
+    if not obj:
+        print(f"You don't have {item}.")
+    else:
+        print(f"It's an {obj}.")
+
+
+# How do you pick up items?
+@adv.when("take ITEM")
+@adv.when("get ITEM")
+@adv.when("pickup ITEM")
+def get(item: str):
+    """Get the item if it exists
+
+    Arguments:
+        item {str} -- The name of the item to get
+    """
+    global current_room
+
+    obj = current_room.contents.take(item)
+    if not obj:
+        print(f"There is no {item} here.")
+    else:
+        print(f"You now have {item}.")
+        inventory.add(obj)
+
+
+# How do you use an item?
+@adv.when("unlock door", item="key")
+@adv.when("use ITEM")
+def use(item: str):
+    """Use an item, consumes it if used
+
+    Arguments:
+        item {str} -- Which item to use
+    """
+
+    global inventory
+
+    # First, do you have the item?
+    obj = inventory.take(item)
+    if not obj:
+        print(f"You don't have {item}")
+
+    # Try to use the item
+    else:
+        obj.use_item(current_room)
+
+
+if __name__ == "__main__":
+    # Look at the starting room
+    look()
+
+    adv.start()