patrickv83/demonata

Branching strategy

In order to maximize commit throughput and avoid version control pitfalls like merge bottlenecks (i.e. having a single dedicated "merge master" to resolve conflicts, merge branches, etc) the strategy should be as follows:

• Create single-feature, disposable branches
• Give branches descriptive names based on the feature, defect, etc you're working on (e.g. the branch for Issue 5, creating an abstract room class, would be named issue5_abstract_room)
• Write tests! See pytest section below.
• Pull requests should be created from your working branch into the master branch. Don't forget to assign reviewers

Virtual environment usage

Virtual environment allows you to create an isolated environment, ensuring among other things that your test environment is consistent.

• Install python virtualenv as normal for your OS.
• Create a virtual environment named "venv" in your GIT_HOME directory. It will automatically install python, easy_install and pip in your virtual environment

virtualenv venv

• Activate your virtual environment. For posix systems (mac, linux):

source venv/bin/activate For windows:

> venv\Scripts\activate

Writing tests for pytest

Tests should be isolated by class (e.g. tests of the item class should be in test_item.py), should be named test_.py, and test files should live in GIT_HOME/tests. Methods should be named test_*. Pytest will automatically discover methods in the correct directory that follow the correct naming scheme.

Run tests from within your virtual environment with "python -m pytest -v" - this is preferred over running the pytest executable, as python inserts the current working directory into the PYTHONPATH.

demonata's Issues

EmptyRoom class

[Controller] Action menu generator

[RoomFactory][Room] New room types implemented and added to Room Factory

Abstract class for character

Player class

map text generator

Enemy class

Action callback

The method that the UI calls when the action menu is activated

[ItemFactory][Equipment][Weapon] Implement weapons and equipment, add to Item Factory

[Room] Special interrogation room

[ItemFactory][RoomFactory] Fully implement the item and room factories in a way that is less sucky and hacky

Character FSM

EnemyRoom class

Abstract class for weapon

Create class diagram for Demonata classes

Acceptance criteria:
Classes (with attributes and methods) for:

• Character
• Item
• Weapon
• Room

Global FSM

UI views for new/save/load game

PlayerEquipment FSM

[Controller] Generate new rooms as player navigates the world. Track visited rooms somehow

Create finite state machines

Create classes for character, item, weapon, room

[UI] Create view and callbacks for inventory access

Should be able to open the inventory, navigate through the items in the inventory, and use items. (e.g. weapon.use() attaches weapon to player.weapon, consumable.use() is the consumable.consume() method)

Abstract class for item

Weapon class

Abstract class for room

Update room text

ArtifactRoom class