shitchell / a-mad-kings-quest Goto Github PK

Link to edit online

Link to SRS document
Room definitions are in section 3.1.1
Door definitions are in section 3.1.2

Play through the game / look through the code and try to ensure (as much as is reasonable) that the output matches the SRS document. Some liberties were taken (such as displaying the user's inventory after picking an item up. the game does display the required "{item_name} was picked up." but takes the liberty of providing some extra output that seemed helpful)

Document any game output that does not meet specifications or open an issue, and I'll make sure it matches.

Probably ought to throw this in a new ABOUT.md file or create some Wiki pages for this

• Create StartCommandController
• Commands
  • create new game save name
  • load save name
  • exit game

Implement chest feature

• Check for key
• If chest is unlocked and opened
  • display contents in room inventory
  • allow contents to be picked up
  • inspect command displays chest contents
• Commands
  • open
  • inspect

• Game description
• Basic walkthrough
• Winning the game
• Command documentation
  • User commands
  • Admin commands

Self explanatory? :p

link to slide on Google Drive

Need to implement a way to have the player win when bos003 is defeated. Has to be in the config files

• Better command help messages / docstrings

Add better command help messages. Command help messages should follow the format:

usage: inspect room
usage: inspect item_name
usage: inspect monster_name
Retrieve information about the current room, an item, or a monster in the current room

This is achieved using the code:

def do_inspect(self, *args):
    """usage: inspect room
       usage: inspect item_name
       usage: inspect monster_name
       Retrieve information about the current room, an item, or a monster in the current room"""
    if args:
        # code...

• Code comments

Need to add comments in the code explaining certain structures, how the parts of the code inter-relate, what functions do, etc...

• Type hinting

Python is dynamically typed, meaning that it doesn't check variable types unlike a statically typed language such as Java. This can cause issues if you inadvertently pass a variable of the wrong type to a method.

However, python does offer something called "type hinting" which allows you to specify what type a variable should be. Then your IDE (such as PyCharm) or type checking tool can warn you if your code has places where the wrong variable types might be used.

Example:

Code

def print_num(num: int, padding: str = " ") -> str:
    text = "%s%i" % (padding, num)
    print(text)
    return text

print_num("not an int", padding=">>")

PyCharm / Type checker warning

=> pep_type_annotations.py:9: error: Argument 1 to "print_num" has incompatible type "str"; expected "int"

Documentation:
https://realpython.com/python-type-checking/

Implement save game command in GameCommandController

Probably ought to create a new ABOUT.md or some Wiki files to describe the MVC along with a few other things Barakat was asking for

Implement puzzle feature

• Create PuzzleCommandController class to limit available commands
• Add "is_active" to CommandController to allow for command based exiting of controller
• Activate puzzle when player uses door
• Commands
  • Ignore
  • Solve
  • Hint
  • Inspect