working on readme

README.md

@@ -8,15 +8,17 @@ Bastion is a Tower Defense type of game.
 
 The game offers the player various missions that he can play.
 In each mission the player is tasked to defend a path going from the entrance of the map to exit of the map.
+The player starts with 200g and 100 HP.
 Each mission is split into multiple rounds. Each round consists of two phases:
 
 1. Phase 1 (Buy phase) - The player can buy towers and place them on the map.
 2. Phase 2 (Combat phase) - In this phase there the enemies spawn at the entrance of the map and start moving towards the exit. The towers will attack the enemies and try to stop them from reaching the exit. More enemies may spawn during the combat phase.
 
 For every creep killed by the player, the player will receive Gold resource.
-Every time a level is finished (Combat phase completes) the player will also receive one Gem.
+Every time a round is finished (Combat phase completes) the player will also receive one Gem.
 The player can use the Gold to buy more towers or upgrade the existing ones.
 If a creep reaches the exit, the player will lose a some health points (HP).
+Players HP does not regenerate between rounds.
 If the player loses all his HP, the game is over and the player has lost.
 If the player completes all the rounds of a mission, the player wins and receives a Score which places him at a leaderboard.
 
@@ -31,7 +33,7 @@ The game starts with a Main menu screen.
 The main menu has the following options (buttons):
 
 1. Play - Starts the game by going to the Mission selection screen
-2. Exit - Exits the game
+2. Options - For now disabled
 
 ## Mission selection screen
 
@@ -45,36 +47,44 @@ The mission selection screen has the following content:
 Mission screen is reached when the player selects a mission from the Mission selection screen.
 The Mission screen has the following content:
 
-1. The map of the mission (image representation)
-2. The path of the creeps (line on the map)
-3. Amount of waves in the mission
-4. The entrance and exit of the map (marked on the map)
-5. Leaderboard - Shows the top 10 players with the highest score for the current mission
-6. Starting Gold - The amount of Gold the player starts with
-7. Starting Gems - The amount of Gems the player starts with
-8. Button to start the mission (Game screen - Buy phase)
-9. Button to go back to the Mission selection screen
+- The map of the mission (image representation)
+- The path of the creeps (line on the map)
+- Amount of waves in the mission
+- The entrance and exit of the map (marked on the map)
+- Starting Gems - The amount of Gems the player starts with
+- Button to start the mission (Game screen - Buy phase)
+- Button to go back to the Mission selection screen
 
 ## Game screen
 
 Every game screen (Buy or Combat phase) has the following content:
+- Game map
+- Options button - Opens the Options panel
+- Sidebar - Content changes based on the phase
+- Topbar - Shows the player's current HP, Gold, Score and Wave/Total Waves
+
+Example:
+![](README_images/2024-09-15-18-47-55.png)
 
 ### Game map
 
-The map is covering the majority of the screen (80%). There is no zooming or panning. Depending on the map aspect ratio, the map may be cropped on the sides.
+The map is covering the majority of the screen (80%). There is no zooming or panning. Depending on the map aspect ratio, the map may be cropped on the sides. The map is a grid where the player can place towers and through which the creeps will travel.
+There are two types of ground on the map:
+- Path - The path where the creeps will travel
+- Buildable - The ground where the player can place towers
+- Non-buildable - The ground where the player can not place towers
 
 ### Options Panel
 
 The options panel is opened by pressed the options button located on the top left corner. The options panel allows the player to:
 
-- Restart current wave
 - Restart mission
 - Return to main menu
 - Close panel (opening it automatically pauses the game)
 
 ### Sidebar
 
-The side bar is located on the right side of the screen and takes up a lesser amount of the screen (20%). It's functionality changes based on whether you are in the buy phase or combat phase.
+The side bar is located on the right side of the screen spanning the full height of the screen and takes up a lesser amount of the screen (20%). It's functionality changes based on whether you are in the buy phase or combat phase.
 
 ### Topbar
 
@@ -83,40 +93,57 @@ The top bar is located to the left of the sidebar and shows you your current HP,
 ## Game screen - Buy phase
 
 During the buy phase (has no time limit), the player may spend their Gold to purchase towers and use their Gems to empower their towers in specific ways depending on the gems used.
+Towers are built when the player drag/drops the tower icon from the sidebar onto the map grid.
+When this happens the gold is deducted from the player's Gold resource.
+Gems are 'slotted' by dragging them from the Gem bag to the tower. This will remove the gem from the Gem bag and empower the tower.
 After the player has finished spending their resources/strategizing, they may end the Buy phase by pressing the "GO" button in the bottom right corner (sidebar).
+It is possible to sell a tower by clicking on the tower, this will bring up a sell button which will refund the player a portion of the Gold spent on the tower (if the tower was bought in the current buy phase then the player will receive the full amount of Gold back).
+Any sloted gems will be returned to the Gem bag.
+It is possible to remove a gem from a tower by clicking on the tower, this will bring up a remove button which will remove the gem from the tower and return it to the Gem bag. This can be done at any time during the buy phase regardless when the Gem was slotted.
+
 
 ### Sidebar - Buy phase
 
-The player starts with 200g and 100 HP.
 During the buy phase the sidebar is split into 2 tabs, the Tower menu and the Gem bag. The tower menu contains towers which you can place on the map grid.
 You may purchase towers with Gold, and certain towers can be empowered with Gems while others can not. Towers themselves can not be upgraded instead you upgrade your Gems.
 Gems are given at the start of the buy phase (specifically only 1 picked out of 3) and are subsequently placed into the gem bag.
 From the Gem bag they can be slotted into a tower, upgraded or combined with other gems.
+On the first tab (Towers menu) the list of available towers is shown as an icon in a vertical list.
+On the second tab (Gem bag) the list of Gems is shown as an icon in a vertical list. Each Gem is represented by single icon (there can be many same type of Gems in the list).
+Below the tower / gem icons there is a detailed description of currently selected tower / gem.
+On the bottom of the sidebar there is a "GO" button which ends the buy phase and starts the combat phase.
 
 _(razmisljam o tome da se gemovi na pocetku buy phasea moraju kupit i/ili mogu se rerollat i/ili da se "upgradeani" ili vec "craftani" gemovi isto mogu kupit)_
 _(takodjer razmisljam da ima market tower koji se moze buildat)_
 
-## Game screen - Combat phase [WIP]
+## Game screen - Combat phase
+During this phase the player has no input (excep the Options menu) and the game is played 'automatically'.
+At specific points in time the creeps will spawn at the entrance of the map and start moving towards the exit traversing the preset path.
+If a tower has an ability to attack a creep it will do so automatically. Type of attack depends on the tower type and the Gems empowering it.
+If a creep receieves enough damage it will die and the player will receive Gold. Any creep which reaches the exit will deal damage to the player's HP. Amount of damage depends on the creeps remaining HP.
+Player may invoke the Options menu at any time during the combat phase. This will pause the game.
+Combat phase will end when all creeps are dead / passed the exit or the player's HP reaches 0.
 
-### Sidebar - Combat phase [WIP]
+### Sidebar - Combat phase
+In the combat phase the sidebar displays same information but it is disabled.
 
 ## Towers
 
 Towers are the buildings you build on the map grid which attack/help you in defeating the creeps that are traversing the path.
-They always have a circular range around them within which they will attack creeps.
-Placing a tower on the grid costs a certain amount of Gold defined by the tower, while empowering it via Gem does not cost anything (Gems are not consumed, more like "slotted" as they can be repossesed).
+Towers always target the the creep closest to the exit. Tower may switch targets if another creep is closer to the exit.
+They always have a circular range around them within which they will attack creeps (if they have an attack).
+Placing a tower on the grid costs a certain amount of Gold defined by the tower, while empowering it via Gem does not cost anything (Gems are not consumed, they are  "slotted" and can be later removed).
 Towers on their own can not be upgraded, only the Gems that are empowering them can be.
-Not all towers can be empowered and they would serve more for utility purposes instead of attacking creeps.
+Not all towers can be empowered (via Gems) and they would serve more for utility purposes instead of attacking creeps.
 
 ### Shooting Tower
-
 Basic tower that shoots 1 projectile at the closest creep.
 
 - Damage: 1
 - Attack Cooldown: 2s
-- Empowerable: Yes
+- Slot count: 3
 - Cost: 100g
-- Range: 100 pixels
+- Range: 2.5 Grid units
 
 ### Circular Tower [WIP]
 
@@ -124,18 +151,19 @@ Basic tower that shoots 1 projectile at the closest creep.
 
 ### Chain tower [WIP]
 
-## Map grid [WIP]
-
 ## Creeps
 
-Creeps are the "things" that travel down the pre determined path of the map from the beginning to the end, which the towers will automatically target and which have a set amount of HP.
+Creeps travel down the pre determined path of the map from the beginning to the end, which the towers will automatically target and which have a set amount of HP.
 Upon reaching the end of the path, they will take away the amount of HP they have from the player's HP (if creep clears the path with 5 HP, player 100 -> 95 HP).
 There are multiple types of creeps with varying amounts of HP, movement speed and special attributes (only vulnerable to divine attacks, etc).
+Each creep follows the same 'line' through the cells which represent the path on the map.
+Creeps may go through another creep if they are faster (they may overlap).
+Creeps may have special attributes.
 
 ### Basic Creep
 
 - Health: 2 HP
-- Speed: 35 pixels per second
+- Speed: 1 Grid unit per second
 - Special attributes: None
 
 ### Quick Creep [WIP]
@@ -150,13 +178,18 @@ Requires tower to be empowered with a divinity gem to deal damage, otherwise imm
 - Speed: 40 pixels per second
 - Special attributes: Undead, Weak to Divinity, Resistant to Soulforge
 
-## Creep waves [WIP]
+## Creep waves 
+Each round may have multiple waves of creeps. 
+Each wave may have different types of creeps and different amounts of creeps.
+A new wave may start at any time, even if the previous wave is not finished.
+Every wave a creep is 'generated' at the map entrance. Once the creep has moved a bit then the next creep in the wave will be 'generated'.
 
 ## Resources
 
 ### Gold
 
 Gold is the resource you get per every creep killed. Every creep decides how much Gold it gives upon its death. Gold is used to purchase towers and alter the map.
+The player starts the game with 200 Gold and can not go below 0 Gold.
 
 ### Gems
 
@@ -189,7 +222,30 @@ _(ideja: scavenger gem, gemovi koji su kombinirani s ovim gemom 25% vise golda n
 ### HP
 
 HP (Health Points) is the resource that you always start with 100 of and you must keep it >0 upon finishing the final round to win the mission.
+The player starts the game with 100 HP and loses the game when it reaches 0 HP.
 
 ### Score
 
-# Data structures and algorithms [WIP]
+At the end of the game (player has survived all rounds) the player receives a score which is based on the amount of Gold the player has left, the amount of HP the player has left and the amount of creeps killed.
+If the player loses the game, the score is always 0.
+
+# Data structures and algorithms
+
+## Tower definition (base)
+- Name 
+- Cost (Gold amount)
+- Gem slot count (0 if not empowerable)
+- Image (icon)
+- Description
+- Damage amount (damage dealt to creeps)
+- Attack Cooldown (time between attacks)
+- Attack range (in Grid units)
+
+## Tower instance (base)
+
+# Future work
+- Add leaderboard functionality to [Mission screen]
+- Ability to restart at the current round of the mission [Options panel]
+- When in combat phase the 'Go' button should be replaced with 'Speed up' toggle button [Sidebar - Combat phase]
+- Add tower selling functionality [Game screen - Combat phase]
+- Add Gem combining functionality [Sidebar - Buy phase]