Merge pull request #95 from Stephenson-Software/develop

Release 0.2.0

Author: dmccoystephenson

.gitignore

@@ -1,2 +1,2 @@
 *.pyc
-*.png
+screenshot*.png

PLANNING.md

@@ -0,0 +1,24 @@
+# Planning Document
+This document is a work in progress. It is a place to collect ideas and plan out the development of the game.
+
+## Overview
+Roam is a 2D survival game where the player explores a procedurally-generated world and interacts with their surroundings.
+
+## Premise
+The player is a survivor of a nuclear war. One of few who managed to get off-planet before the radiation killed everyone. The player is stranded on an unknown planet and must survive by gathering resources and building a base.
+
+## Mechanics
+### Energy
+Energy decreases when the player moves and replenishes when the player eats food.
+
+### Map Generation
+The map is generated as the player explores.
+
+### Inventory
+The player has an inventory that can hold items. The player can cycle through the inventory with the `e` and `q` keys and can open/close the inventory with the `i` key.
+
+### Crafting
+The player can craft items using the items in their inventory.
+
+### Food
+The player can eat food to replenish energy. Food can be found in the world or grown by the player.

README.md

@@ -1,12 +1,8 @@
 # Roam
 This game allows you to explore a procedurally-generated 2D world and interact with your surroundings.
 
-## Mechanics
-### Energy
-Energy decreases when the player moves and replenishes when the player eats food.
-
-### Map Generation
-The map is generated as the player explores.
+## Planning Document
+The planning document can be found [here](./PLANNING.md)
 
 ## Controls
 Key | Action
@@ -17,8 +13,11 @@ s | move down
 d | move right
 shift | run
 ctrl | crouch
-e | gather
-q | place
+left mouse | gather
+right mouse | place
+i | open/close inventory
+e | cycle inventory right
+q | cycle inventory left
 print screen | take screenshot
 esc | quit
 
@@ -29,7 +28,7 @@ You can find the support discord server [here](https://discord.gg/49J4RHQxhy).
 ### Developers
 Name | Main Contributions
 ------------ | -------------
-Daniel Stephenson | Creator
+Daniel McCoy Stephenson | Creator
 
 ## Libraries
 This project makes use of [graphik](https://github.com/Preponderous-Software/graphik) and [py_env_lib](https://github.com/Preponderous-Software/py_env_lib).