Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README a bit #59

Merged
merged 2 commits into from May 22, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 31 additions & 9 deletions README.md
@@ -1,15 +1,34 @@
[![Code Smells](https://sonarqube.luk4s.dev/api/project_badges/measure?project=zhaw-it19tb-win_unity-crawler_AYAFv6FGpQ2_0yxRU-Fu&metric=code_smells&token=3e51bf3c88d913644b5f4ecdfb4b6457266680b4)](https://sonarqube.luk4s.dev/dashboard?id=zhaw-it19tb-win_unity-crawler_AYAFv6FGpQ2_0yxRU-Fu)

# Unity-crawler
# Unity-Crawler

## Special Floor Tiles
Following tiles are used as teleporters. If you step on them, glowing animation appears which means the teleporter is active and can be used by clicking T. THe following Tiles can be used as teleporters.
## How to play

<img alt="Red Teleporter" src="Assets\Assets_DevilsWorkShop\Low_Poly_Pixel_2D_Blocks_DevilsWorkShop_v04\Textures\assets_1024x1024\isometric_0037.png" width="70">
<img alt="Blue Teleporter" src="Assets\Assets_DevilsWorkShop\Low_Poly_Pixel_2D_Blocks_DevilsWorkShop_v04\Textures\assets_1024x1024\isometric_0040.png" width="70">
<img alt="Green Teleporter" src="Assets\Assets_DevilsWorkShop\Low_Poly_Pixel_2D_Blocks_DevilsWorkShop_v04\Textures\assets_1024x1024\isometric_0042.png" width="70">
Your mission is to survive in the mysterious dungeons. To do so, move your character using the `wasd` keys, press shift to sprint. Fight against various enemies by using your close combat skills using the space key or by using your ranged attack by left-clicking with your mouse to cast a deadly spell. But be aware that each spell takes up some energy so you have to wait a bit between each spells to recharge.

### Combat

<img width="83" align="left" alt="image" src="https://user-images.githubusercontent.com/8350985/169712406-f50efed1-cb26-4cca-ab54-a70e36c0ca6d.png">
<img width="92" align="left" alt="image" src="https://user-images.githubusercontent.com/8350985/169712417-3debda17-ce23-456c-962c-8c77a6e4d822.png">

The dungons are a dangerous place. You'll have to face various enemies.

They each have a different style of attack, so you may chose wisely between your combat techniques.

In some rooms, you'll find a boss enemy. These have special attacks and are harder to kill, but it's essential to face them to proceed to other rooms in the game.

### Navigate using special floor tiles

The Following tiles are used as teleporters. If you step on them, they start to glow which means the teleporter is active and can be used by clicking `T`. Teleporters are all over the world and look like this:

<img alt="Red Teleporter" src="Assets\Assets_DevilsWorkShop\Low_Poly_Pixel_2D_Blocks_DevilsWorkShop_v04\Textures\assets_1024x1024\isometric_0037.png" width="70" style="float: left">
<img alt="Blue Teleporter" src="Assets\Assets_DevilsWorkShop\Low_Poly_Pixel_2D_Blocks_DevilsWorkShop_v04\Textures\assets_1024x1024\isometric_0040.png" width="70" style="float: left">
<img alt="Green Teleporter" src="Assets\Assets_DevilsWorkShop\Low_Poly_Pixel_2D_Blocks_DevilsWorkShop_v04\Textures\assets_1024x1024\isometric_0042.png" width="70" style="float: left">

### User controls

All these key-bindings are available:

## User controls
|Key | Effect |
|--- |--- |
|Space | Close combat |
Expand All @@ -20,9 +39,12 @@ Following tiles are used as teleporters. If you step on them, glowing animation
|T | Teleports the player to the connected telporter tile |
|Shift | Doubles the speed of the player |

## Collectable items
### Collectable items

When an enemy dies, there's a chance that it drops a collectible potion which temporarily upgrades the character's skills.
The following potions are available:

| Asset | Effect |
| Potion | Effect |
|--- |--- |
|<img alt="Blue Potion" src="Assets\Resources\pot1blue.png" width="40"> | Increases the players speed by 20 percent |
|<img alt="Red Potion" src="Assets\Resources\pot1red.png" width="40"> | Heals 30 percent of the player's health |
Expand Down