diff --git a/README.md b/README.md index 963c784..1acd8c5 100644 --- a/README.md +++ b/README.md @@ -45,27 +45,6 @@ the root of the project. |2|Buy shop item 2.| |3|Buy shop item 3.| -## Enemies - -|Name|Image|Description| -|:---:|:---:|:---:| -|Drone|![drone_enemy](assets/gifs/drone.gif)|Most basic enemy in the game. Moves towards the bottom of the arena and does defense damage on arrival.| -|Pawn|![pawn_enemy](assets/gifs/pawn.gif)|Moves towards the bottom of the arena at a reduced speed and does defense damage on arrival. Periodically fires a blast.| -|Strafer|![strafer_enemy](assets/gifs/strafer.gif)|Strafes left and right towards the bottom of the arena at a reduced speed and does defense damage on arrival. Periodically fires a blast.| -|Flying Polyp|![flying_polyp_enemy](assets/texture/portraits/polyp_portrait.png)|Coming soon.| - -## Allies - -|Name|Image|Description| -|:---:|:---:|:---:| -|Hauler|![hauler_ally](assets/gifs/hauler.gif)|Moves towards the bottom of the arena at a very reduced speed and grants defense on arrival.| - -## Bosses - -|Name|Image|Description| -|:---:|:---:|:---:| -|Repeater|![repeater_boss](assets/texture/portraits/repeater_portrait.png)|Coming soon.| - ## MVP Specification **Inspirations**: Raiden, Binding of Isaac diff --git a/assets/gifs/gameplay.gif b/assets/gifs/gameplay.gif deleted file mode 100644 index 0f7d414..0000000 Binary files a/assets/gifs/gameplay.gif and /dev/null differ diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index f96aff5..fb03f85 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -3,6 +3,7 @@ - [Introduction](./intro.md) - [Gameplay](./gameplay.md) - [Controls](./controls.md) + - [Characters](./characters.md) - [Items](./items.md) - [Consumables](./consumables.md) - [Enemies](./enemies.md) diff --git a/book/src/allies.md b/book/src/allies.md index 49f4f36..bd978f4 100644 --- a/book/src/allies.md +++ b/book/src/allies.md @@ -1 +1,7 @@ # Allies + +Allies provide a temporary objective. Make sure they survive and you will be rewarded. + +|Name|Image|Description| +|:---:|:---:|:---:| +|Hauler|![hauler_ally](assets/hauler.gif)|Moves towards the bottom of the arena at a very reduced speed and grants defense on arrival.| diff --git a/assets/gifs/drone.gif b/book/src/assets/drone.gif similarity index 100% rename from assets/gifs/drone.gif rename to book/src/assets/drone.gif diff --git a/assets/gifs/hauler.gif b/book/src/assets/hauler.gif similarity index 100% rename from assets/gifs/hauler.gif rename to book/src/assets/hauler.gif diff --git a/assets/gifs/pawn.gif b/book/src/assets/pawn.gif similarity index 100% rename from assets/gifs/pawn.gif rename to book/src/assets/pawn.gif diff --git a/assets/gifs/strafer.gif b/book/src/assets/strafer.gif similarity index 100% rename from assets/gifs/strafer.gif rename to book/src/assets/strafer.gif diff --git a/book/src/bosses.md b/book/src/bosses.md index 70ebbb5..1504d93 100644 --- a/book/src/bosses.md +++ b/book/src/bosses.md @@ -1 +1,7 @@ # Bosses + +Bosses arrive at the end of a stage. Destory them to move on to the next stage. + +|Name|Image|Description| +|:---:|:---:|:---:| +|Repeater|![repeater_boss](assets/repeater_portrait.png)|WIP. diff --git a/book/src/characters.md b/book/src/characters.md new file mode 100644 index 0000000..413fd30 --- /dev/null +++ b/book/src/characters.md @@ -0,0 +1,9 @@ +# Characters + +In the future, the player will be able to choose to play as one of many +characters. Each character has a unique special ability. + + +|Name|Image|Special Ability| +|:---:|:---:|:---:| +|Juggernaut|![juggernaut](assets/spaceship_portrait.png)|Barrel roll to the left or right.| diff --git a/book/src/enemies.md b/book/src/enemies.md index 2336c32..8363b41 100644 --- a/book/src/enemies.md +++ b/book/src/enemies.md @@ -1 +1,10 @@ # Enemies + +Enemies can damage the player and the defense. Upon being destroyed they have a +chance to drop consumables. + +|Name|Image|Description| +|:---:|:---:|:---:| +|Drone|![drone_enemy](assets/drone.gif)|Most basic enemy in the game. Moves towards the bottom of the arena and does defense damage on arrival.| +|Pawn|![pawn_enemy](assets/pawn.gif)|Moves towards the bottom of the arena at a reduced speed and does defense damage on arrival. Periodically fires a blast.| +|Strafer|![strafer_enemy](assets/strafer.gif)|Strafes left and right towards the bottom of the arena at a reduced speed and does defense damage on arrival. Periodically fires a blast.| diff --git a/book/src/gameplay.md b/book/src/gameplay.md index 23fde97..67e8a92 100644 --- a/book/src/gameplay.md +++ b/book/src/gameplay.md @@ -1,11 +1,10 @@ # Gameplay -In space_shooter_rs, you play as as a spaceship defending a planet. The goal of -the game is -to survive levels by destroying enemies, collecting consumables, buying items, -and defeating the final boss. +In space_shooter_rs, you play as as a spaceship defending an objective. The goal +of the game is to survive levels by destroying enemies, collecting consumables, +buying items, and defeating the final boss. In this section you can find detailed information about the enemies, consumables, items, enemies, allies, and bosses in the game. -![gameplay](assets/gameplay.gif) \ No newline at end of file +![gameplay](assets/gameplay.gif)